6Web Services On Demand API Calls

Web Services On Demand API Calls

This chapter describes the Web Services On Demand API Calls. It contains the following topics:

• Web Services On Demand API Calls

• Web Services v1.0 API Calls

• Web Services v2.0 API Calls

• Service API Calls

• Administrative Services API Calls

• Data Loader API Calls

Web Services On Demand API Calls

This methods that the Oracle CRM On Demand Web services can call are as follows:

• The methods of the Web Services v1.0 API that are called on Oracle CRM On Demand objects to insert, update, delete, and find data within a specified Oracle CRM On Demand instance.

• The methods of the Web Services v2.0 API that are called on Oracle CRM On Demand objects to insert, update, delete, and find data within a specified Oracle CRM On Demand instance.

• The service API methods that are used to perform queries and other operations on nondata records through Web services.

• The methods of the Administrative Services API that are used to automate the administration of a company's configurations.

• The methods of the Data Loader API that are used to perform bulk data import operations.

For each of these methods, usage, arguments taken, and return values are detailed.

Tip: Sample code for the various APIs might be available in the Oracle CRM On Demand Sample Code public repository. You must have an account to access the samples. See, for example: https://www.oracle.com/downloads/samplecode/crmod-samplecode-downloads.html.

Considerations When Deleting Child Records

When you delete a child record, either through the UI or a Web service call, a foreign key reference to the child is maintained in the parent record. This foreign key reference is maintained so that if the deleted child record is restored, the association that the record had with parent records can also be restored.

Web service calls querying the record with the foreign key reference can give unexpected results. To avoid this situation, it is recommended that before you delete a child record, you first remove the association between the child record and the parent record. Web service calls will then not return the foreign key reference.

If you want to remove a retained foreign key reference from a parent record, associate a temporary child record, then remove the association and delete the temporary child record.

Web Services v1.0 API Calls

The Web Services v1.0 methods are listed in the following table. These methods can be called on most Oracle CRM On Demand objects (record types), for example, Account, Contact, Opportunity, and so on, including Custom Objects 01 through 03, but not Custom Objects from 04 onwards.

Note: The actual method names consist of the object name prefix and Delete, Insert, and so on, for example, AccountDelete and AccountInsert are methods of the Account service.

Table Web Services v1.0 Methods

Method	Comments
Delete	Finds records in the Oracle CRM On Demand database that match specified field values, and then deletes them (in other words, puts them into the Deleted Items area).
DeleteChild	Deletes child records from the Oracle CRM On Demand database, or removes the association between the child and the parent object.
Insert	Inserts new records into the Oracle CRM On Demand database.
InsertChild	Inserts new child records into the Oracle CRM On Demand database.
InsertOrUpdate	Updates existing records or inserts a new record if one did not exist.
QueryPage	Executes a query against a specified list of records, and returns a subset of the records that match the search criteria set by the method arguments.
Update	Updates records with a new value.
UpdateChild	Updates child records with a new value.

For each object, the methods are defined in the WSDL file for that object. Many of the methods described in this chapter can be called on all of the objects.

Before processing requests for the Insert and InsertOrUpdate methods, Oracle CRM On Demand checks whether the Record allotment for the company has been reached. If the allotment has been reached, the request is not processed.

Depending on whether an object is a parent or child object, Web services methods can act in different ways on the object in question. These differences are described in the following topics.

Note: For Web Services v1.0, operations on a child object with more than 10,000 records cannot be processed. It is recommended that you use Web Services v2.0 operations to overcome this limitation.

User Keys

The objects (both child and parent level) provided in the input arguments for the Web Services v1.0 methods must provide data in at least one of the user keys for the given object. You use the user key information to uniquely identify records. If no user key values are provided, or if there is a conflict with the user keys of an existing record, the method fails, and a SOAP error is thrown by the API.

The Echo Argument

Oracle CRM On Demand Web services using the methods Insert, Update, InsertAndUpdate, Delete, InsertChild, UpdateChild, and DeleteChild can specify an Echo input argument. The Echo string is used only for Integration events and is not required. Echo is case-sensitive and controls whether data sent to Oracle CRM On Demand through integration Web services are recorded as transactions. The default value is On. When the Echo value is On or missing, the transaction is recorded. When the Echo value is Off, the transaction is not recorded.

Note: For Java users, the Echo string is required for all input methods. The echo string can be set to Off.

Delete

Removes records of a specified record type from the Oracle CRM On Demand database.

Usage

You use the Delete method to remove one or more records of a particular object from an Oracle CRM On Demand instance.

The deleted records appear in the Deleted Items folder and can be restored through the Oracle CRM On Demand UI.

Note: To conform with the business logic of Oracle CRM On Demand, be careful about the order in which objects are deleted. You cannot delete some objects unless some action is performed on its child objects. For example, you cannot delete an account unless you reassociate all its service requests with a different account.

Cascade delete of child records is consistent with the cascade delete functionality in the Oracle CRM On Demand UI. It is recommended that deletion of parent objects through Web services requests also specify which child records are to be deleted to ensure the appropriate deletion of child records. For more information about deleting records, see Oracle CRM On Demand Online Help.

Note: If you update an object, and the child is not in the input, that child is deleted from Oracle CRM On Demand. For more information, see Update.

Arguments

The following table describes the arguments taken by the Delete method.

Table Arguments Taken by the Delete Method

Name	Description	Required	Default	I/O
ListOf(Object). For example, ListOfAccount	The list of object instances to be deleted.	Yes	Not applicable	Input/Output
Echo	Controls whether data sent to Oracle CRM On Demand through integration Web services are recorded as transactions.	No	On	Input

Return Value of the Call

The status key for each of the deleted objects.

Related Topic

Update.

DeleteChild

Removes child records from the Oracle CRM On Demand database.

Usage

You use the DeleteChild method to remove one or more child records of a particular object from an Oracle CRM On Demand instance, or remove the association between the child and parent object.

The deletion of child records or removal of association follows the same pattern as for deletion in the UI of the Oracle CRM On Demand application. For example, if you use AccountDeleteChild on a Contact child record, the association is removed, but the Contact is not deleted. On the other hand, if you use AccountDeleteChild on a Team child record, that record is deleted. However, the integration events generated in the UI and from Web services requests differ for child objects of Account, Contact, and Opportunity. For more information about these differences in integration events and about deleting records, see the information about workflow rules in Oracle CRM On Demand Online Help.

Caution: The parent object can be deleted by the DeleteChild method in some cases when a child object is not specified when executing the different DeleteChild methods. Nodes with at least one child are called internal nodes and nodes without children are called leaf nodes. DeleteChild operates on leaf nodes, so that if the request specifies a parent that has no children, the parent is deleted. You can avoid this situation by calling the Update method on the parent with an empty container for the children.

Arguments

The following table describes the arguments taken by the DeleteChild method.

Table Arguments Taken by the Delete Child Method

Name	Description	Required	Default	I/O
ListOf(Object). For example, ListOfAccount	The list of child object instances to be deleted. Each child object has an associated parent object.	Yes	Not applicable	Input/Output
Echo	Controls whether data sent to Oracle CRM On Demand through integration Web services are recorded as transactions.	No	On	Input

Return Value of the Call

The status key for each of the deleted child records.

Insert

Inserts new records in the Oracle CRM On Demand database.

Usage

You use the Insert method to create one or more records of a particular object in an Oracle CRM On Demand instance.

When inserting a batch of records, the batch is treated as a single transaction. If one record fails to insert during a batch insertion, the entire operation is rolled back and no records are inserted.

Insert calls must include values for fields that are required for the object. Fields can be conditionally required, that is they become required if the data specified for other fields on the record meets the criteria defined in an expression for the field. For more information about conditionally-required fields, see Oracle CRM On Demand Online Help.

The following table outlines how the Insert method acts on parent and child objects to create or update an object instance.

Table Effect of Insert on Parent and Child Objects

Method	New Parent	New Child	Existing Parent	Existing Child Record
Insert	New parent instance	New child instance	Error	Associate to new parent instance

Arguments

The following table describes the arguments taken by the Insert method.

Table Arguments Taken by the Insert Method

Name	Description	Required	Default	I/O
ListOf(Object). For example, ListOfAccount	The list of object instances to be inserted.	Yes	Not applicable	Input/Output
Echo	Controls whether data sent to Oracle CRM On Demand through integration Web services are recorded as transactions.	No	On	Input

Return Value of the Call

The status key for each of the Oracle CRM On Demand objects.

Related Topic

Update.

InsertChild

Inserts new child records in the Oracle CRM On Demand database.

Usage

You use the InsertChild method to create one or more child records of a particular object in an Oracle CRM On Demand instance.

Arguments

The following table describes the arguments taken by the InsertChild method.

Table Arguments Taken by the Insert Child Method

Name	Description	Required	Default	I/O
ListOf(Object). For example, ListOfAccount	The list of child object instances to be inserted. Each child object has an associated parent object	Yes	Not applicable	Input/Output
Echo	Controls whether data sent to Oracle CRM On Demand through integration Web services are recorded as transactions.	No	On	Input

Return Value of the Call

The status key for each of the inserted child records.

InsertOrUpdate

Updates existing records or inserts a new record if one did not exist for an instance of the object.

Usage

You use the InsertOrUpdate method to update one or more records of a particular object in an Oracle CRM On Demand instance. Use the user key specified for the parent level objects in the input argument to determine whether to insert each of the parent records, or to update an existing parent record.

Insert calls must include values for fields that are required for the object. Fields can be conditionally required, that is they become required if the data specified for other fields on the record meets the criteria defined in an expression for the field. For more information about conditionally-required fields, see Oracle CRM On Demand Online Help.

The following table outlines how the InsertOrUpdate method acts on parent and child objects to create or update an object instance.

Table Effect of InsetOrUpdate on Parent and Child Objects

Method	New Parent	New Child	Existing Parent	Existing Child Record
InsertOrUpdate	New parent	New child	Update parent	Update child

Arguments

The following table describes the arguments taken by the InsertOrUpdate method.

Table Arguments Taken by the InsertOrUpdate Method

Name	Description	Required	Default	I/O
ListOf(Object). For example, ListOfAccount	The object instances to be inserted or updated.	Yes	Not available	Input/Output
Echo	Controls whether data sent to Oracle CRM On Demand through integration Web services are recorded as transactions.	No	On	Input

Return Value of the Call

The status key for each of the inserted or updated objects.

Related Topic

Update, Insert

QueryPage

Executes a query against the set of records for an object, and returns the subset of the records that match the search criteria set by the method arguments.

Query by Template

To improve performance, the QueryPage result contains only those fields and objects that are included in the QueryPage request. To retrieve the values of fields that are not a part of the search criteria, the field must be included in the search request with a blank value.

Query by Children

For all Oracle CRM On Demand object methods (except Attachment), it is possible to query using one operation within a parent-child relationship. This type of query is called Query By Children. The query can be assembled using parent attributes as well as child attributes. You can query for all children of a particular parent or set of parents, all parents of a particular child or set of children, or for both parents and children of a particular set.

Note: When performing a query using Query By Children, certain fields on a child object might not be filterable.

Not all child objects are filterable in Web Services v1.0 (for example, the Partner child of Opportunity).

Caution: This type of query performs slowly and must only be used when necessary.

As an example of how you can search for parent records using criteria on a child:

<UseChildAnd>true</UseChildAnd>
	<ListOfContact>
		<Contact>
			<ContactFirstName>=’John’</ContactFirstName>
			<ContactLastName/>
			<ListOfAddress>
				<Address>
  					 <Country>=’Canada’</Country>
				</Address>
			</ListOfAddress>
		</Contact>
</ListOfContact>

This query would return all contacts where the first name is John and at least one of John’s addresses is for Canada. The child criteria are appended to the parent using an AND or OR operator based on the value of the argument UseChildAnd. When UseChildAnd is true, the child criteria are "ANDed", otherwise they are "ORed".

Using the PageSize and StartRowNum Arguments

The PageSize argument, which has a maximum value of 100, is used to specify the maximum number of records to be returned in a QueryPage response.

The pagesize and startrownum arguments are specified in requests as follows:

<StartRowNum>0</StartRowNum>
<PageSize>20</PageSize>
<ListOfAccount>

Depending on the value of PageSize, records are returned as follows:

• If the number of records in the record set is less than the PageSize value, the full record set is returned, and the LastPage argument is set to true.

• If the number of records in the record set exceeds the PageSize value, only the number of records specified by the PageSize parameter is returned, and the LastPage value is false.

• For a query whose record set exceeds the PageSize value, incrementing the StartRowNum argument by PageSize returns the next PageSize number of records. For example, to return a record set with 997 records you can use a PageSize of 100 as follows:

PageSize	StartRowNum	Records Returned	LastPage
100	0	0-99	false
100	100	100-199	false
100	200	200-299	false
100	300	300-399	false
100	400	400-499	false
100	500	500-599	false
100	600	600-699	false
100	700	700-799	false
100	800	800-899	false
100	900	900-997	true

• If the size of the record set is greater than PageSize, and this is a subsequent query where there are less than PageSize number of records remaining to be returned, all of the remaining records are returned and the LastPage attribute has a value of true.

Even though the QueryPage method returns a limited number of records, the results are cached, and can then be retrieved by calling the QueryPage method with a value of PageSize+1 for the StartRowNum argument. To retrieve all records in the result set, StartRowNum must be incremented by PageSize for each subsequent QueryPage request until a QueryPage response is returned with LastPage equal to true.

About Oracle CRM On Demand Query Syntax

The query syntax supports only a small subset of binary and unary operators. No Siebel Query Language constructs or functions are supported. The query syntax is summarized in the following table.

Table Query Syntax for Query Page

Syntax Type	Notes
expression
{Operator} {Value}	Operator can be binary or unary. The {Value} need only be specified for binary operators. Every expression must start with an operator to avoid ambiguity. There is no default operator.
(expression) conjunction (expression)	A conjugated expression must be enclosed in parentheses to avoid ambiguity. However, nonconjugated expressions must not be enclosed in parentheses.
conjunction
OR	None
AND	None
unary operator	None
IS NULL	Used to find a match for a value that has no value
binary operator
=	None
~=	Denotes a case-insensitive exact search (no wildcards used)
<	Must be specified as &lt; to ensure well-formed XML.
<=	Must be specified as &lt;=
>	None
>=	None
<>	Must be specified as &lt;>
LIKE	Wildcard characters are treated as such only in the context of the operator LIKE.
~LIKE	Denotes a case-insensitive wildcard search
value
'literal'	Literal data is always enclosed in single quotes. To use a single quote within a literal, place another single quote immediately beside that quote. In this way, the query recognizes the quote as a literal and not as an operator. For example, the string ab'c is specified as ab''c. To use the special characters such as asterisk (*), question mark (?), and backslash (\) in queries, preceded them with the \ character. For example, to use the ? wildcard operator in a query, precede it with the \ character as follows: \?

Caution: Queries that are case-insensitive or with leading wildcard characters will perform slowly and must only be used when necessary. In some cases, you can however use shadow fields, see Using Shadow Fields for Better Search Performance.

Querying Oracle CRM On Demand Data Using Web Services

The QueryPage functions require a list of object instances as input to perform a query. This input argument is called ListOf(Object). For example, the ContactQueryPage method requires the ListOfContact argument. Each ListOf(Object) argument requires at least one instance of the Object to specify a valid query.

To query an object by a certain field, specify the expression that corresponds to the desired result. The examples in this topic cover the corner cases of quote and wildcard escaping. Assume that a table in the Oracle CRM On Demand database contains the following values for a particular column that is being queried:

abc
abcd
'abc'
= 'abc'
abc?d
abc*d
aBc*D
abcd
abc*d
abc\d
abc\*d
abc\\*d
abc\d
abc\*'d
abc\?"d
abc\*"d
abc\*'"d
(NULL value)

The following table specifies the returned record sets for various values of each field value that maps to the preceding list.

Table Returned Record Sets

Field Value	Returned Record Set	Comments
abc	Not applicable	An unquoted value without an explicit operator is invalid input.
'abc'	Not applicable	A quoted value without an explicit operator is invalid input.
= '''abc	''''abc'	None
= "'abc'"	Not applicable	Double quotes are not allowed by the Oracle CRM On Demand Validator. Consequently, this example returns an error message.
= 'abc	'abc	None
= '= ''abc	'''= 'abc'	None
= '= 'abc''	Not applicable	The caller is responsible for correctly formatting quotes in Query* methods. This example does not have correctly formatted quotes, so it results in an error.
= 'abc?d	'abc?d	None
= 'abc\?d	'abc?d	None
LIKE 'abc\?d	'abc?d	None
LIKE 'abc?d	'abc?d abc*d abc\d	None
~LIKE 'abc?d	'abc?d aBc*D abc*d abc\d	None
= 'abc*d'	abc*d	Any wildcard character that has not been formatted with quotes is treated as if it were formatted with quotes.
= 'abc\*d	'abc*d	None
= 'abc\\*d	'abc\*d	None
LIKE 'abc\\*d	'abc\d abc\*d abc\\*d abc\d abc\*'d abc\?"d abc\*"d abc\*'"d	None
= 'abc\\\*"d	'abc\*"d	None
= 'abc\\?"d	'abc\?"d	None
= 'abc\\\?"d	'abc\*"d	None
LIKE 'abc\\?"d	'abc\?"d abc\*"d	None
LIKE 'abc\\\?"d	'abc\?"d	None
LIKE 'abc\\*"d	'abc\?"d abc\*"d abc\*'"d	None
LIKE 'abc\\\*"d	'abc\*"d	None
= 'abc\\\*''d	'abc\*'d	None
~ LIKE 'abc*\d	'aBc*D abc*d abcd abc*d	None
LIKE 'abc*\d	'abc*d abcd abc*d	None
(empty field)	Not applicable	An empty field value does not influence the search specification in Query by Template. Note: A query in which all fields are empty fields returns all records.
IS NULL	(empty field) (( > 'abc*' ) AND ( < 'abcd' ))	None
OR (~= 'abc*d')	abc*d aBc*D abc*d	None
NOT LIKE 'abc?d'	Not applicable	The Oracle CRM On Demand Query Validator does not support the NOT operator, so this query returns an error.
> 'abc' BUT < 'abcd'	Not applicable	BUT is not a valid conjunction. Consequently, this query returns an error.

Querying Multiple Fields

To specify a query on multiple fields, expressions must be provided for each field comprising the search specification. When multiple fields in an object instance have expressions, the QueryPage method result is the intersection of all the expressions, or in other words, all of the expressions are combined using the AND operator. This is outlined in the following section.

Example 1: Combining Expressions Using the AND Operator

The Web service client requires the first name, last name, and job title of all the contacts in Oracle CRM On Demand that have a job title equal to CEO and a last name equal to Doe. The XML representation of the ListOfContact object that must be sent in the ContactQueryPage call is as follows:

<ListOfContact>
	<Contact>
		<JobTitle>=‘CEO’</JobTitle>
		<ContactLastName>='Doe'</ContactLastName>
		<ContactFirstName />
	</Contact>
</ListOfContact>

Multiple Expressions on a Single Field

If you want to apply multiple expressions to a single field, you can combine each expression using either the AND or the OR operator. The result is either the intersection or the union of the object instances respectively.

Note: For multiple expressions on a single field, each expression must be enclosed in brackets.

Example 2: Combining Multiple Expressions Using the AND Operator

The Web service client requires the first name, last name, and job title of all the contacts that have been updated between July 28, 2009 6:30am and July 28, 2009 6:45 am.

Send the following XML representation of the ListOfContact object in the ContactQueryPage call:

<ListOfContact>
  <Contact>
    <JobTitle/>
    <ContactLastName/>
    <ContactFirstName/>
    <LastUpdated> (>='07/28/2009 06:30:00') AND (<='07/28/2009 06:45:00')</LastUpdated >
  </Contact>
</ListOfContact>

Example 3: Combining Multiple Expressions Using the OR Operator

The Web service client requires the first name, last name, and job title of all the contacts in Oracle CRM On Demand that have a last name equal to Doe or Brown.

Send the following XML representation of the ListOfContact object in the ContactQueryPage call:

<ListOfContact>
	<Contact>
		<JobTitle />
		<ContactLastName>(='Doe') OR (=’Brown’)</ContactLastName>
		<ContactFirstName />
	</Contact>
</ListOfContact>

Specifying Books in Queries

For queries on record types that support books, you can use the BookId or BookName arguments to constrain the query to only the records in a particular book. For more information about the use of books, see Oracle CRM On Demand Online Help.

Arguments

The following table describes the arguments taken by the QueryPage method.

Table Arguments Taken by the QueryPage Method

Name	Description	Required	Default	I/O
ListOf(Object). For example, ListOfAccount	The list of object instances queried (input), and after query execution, the list of object instances returned (output).	Yes	Not applicable	Input/Output
PageSize	The maximum number of records displayed on a page following a query.	No	10	Input
StartRowNum	Indicates the row from which the QueryPage method starts to return records. Use the StartRowNum argument to return a set of records for any given method. For example, if PageSize=100 and you want to return records 1-100, you set StartRowNum to 0. Then, if you want to return records 101-200, you set StartRowNum to 100, and run the query again. You continue doing this until the last page is returned. In this way, you can return all records for a particular query.	No	0	Input
UseChildAnd	If this argument is set to true, the query result set returns the set of records that satisfy both parent and child search criteria. (That is, the query set returned is the AND combination of parent and child queries.) If this argument is set to false (or not set at all), the query result set returns the set of records that satisfy either the parent or the child search criteria. (That is, the query set returned is the OR combination of parent and child queries.)	No	False	Input
BookId	The book Id.	No	Not applicable	Input
BookName	The book name. This argument is ignored if a value for BookId is supplied.	No	Not applicable	Input
IncludeSubBooks	Whether subbooks are to be included.	No	False	Input

Return Value of the Call

An object or list of objects of the type on which the method was called.

• LastPage. A Boolean value that indicates whether or not the last value in the query set has been returned.

Update

Updates records with a new value.

Usage

You use the Update method to update one or more records of a particular object in an Oracle CRM On Demand instance.

Note: If the company administrator customizes a record type to add a required field, Oracle CRM On Demand does not check for the required field when existing records are updated. When you update the record without the required field through a Web services request, or merge it with a record that does not have the required field, the record is updated or merged without error. This is the intended behavior; when a field is made required, it is the responsibility of the administrator to update all existing records to populate the required field. On inserting new records however, Oracle CRM On Demand checks for the required field.

The following table outlines how the Update method acts on parent and child objects to update an object instance.

Table Effect of Update on Parent and Child Objects

Method	New Parent	New Child	Existing Parent	Existing Child Record	Existing Child Record But Not in Input
Update	Error	New child	Update parent	Update child	Child is removed

Arguments

The following table describes the arguments taken by the Update method.

Table Arguments Taken by the Update Method

Name	Description	Required	Default	I/O
ListOf(Object). For example, ListOfAccount	The object instance to be updated.	Yes	Not applicable	Input/Output
Echo	Controls whether data sent to Oracle CRM On Demand through integration Web services are recorded as transactions.	No	On	Input

Return Value of the Call

The status key for each of the updated records.

UpdateChild

Updates a child record with a given value in the Oracle CRM On Demand database.

Usage

You use the UpdateChild method to update one or more child records of a particular object in an Oracle CRM On Demand instance.

Arguments

The following table describes the arguments taken by the UpdateChild method.

Table Arguments Taken by the Update Child Method

Name	Description	Required	Default	I/O
ListOf(Object). For example, ListOfAccount	The list of child object instances to be updated. Each child object has an associated parent object.	Yes	Not applicable	Input/Output
Echo	Controls whether data sent to Oracle CRM On Demand through integration Web services are recorded as transactions.	No	On	Input

Return Value of the Call

The status key for each of the updated child records.

Web Services v2.0 API Calls

The Web Services v2.0 API methods are listed in the following table. These methods can be called on all Oracle CRM On Demand objects (record types), for example, Account, Contact, Opportunity, and so on, including all Custom Objects.

The objects provided in the input arguments for the methods must provide data in at least one of the user keys for the given object. You use the user key information to uniquely identify records. If no user key values are provided, or if there is a conflict with the user keys of an existing record, the method fails, and a SOAP error is thrown by the API.

If a request supplies an ID value in a reference field, an association is created between two records through, for example, the insert operation. Joined in fields from a referenced object are read-only.

Note: The actual method names consist of the object name prefix and Delete, Insert, and so on, for example, AccountDelete and AccountInsert are methods of the Account service.

Table Web Services v2.0 API Methods

Method	Comments
Delete	Finds records in the Oracle CRM On Demand database that match specified field values, and then deletes them (in other words, puts them into the Deleted Items area).
Execute	Executes multiple update, insert, and delete operations on separate records in the Oracle CRM On Demand database.
Insert	Inserts new records into the Oracle CRM On Demand database.
QueryPage	Executes a query against a specified list of records, and returns a subset of the records that match the search criteria set by the method arguments.
Update	Updates records with a new value.

Before processing requests for the Insert method, Oracle CRM On Demand checks whether the Record allotment for the company has been reached. If the allotment has been reached, the request is not processed.

For each object, the methods are defined in the WSDL file for that object. Many of the methods described in this chapter can be called on all of the objects.

The Echo Argument

Oracle CRM On Demand Web services using the methods Insert, Update, InsertOrUpdate, Delete, InsertChild, UpdateChild, and DeleteChild can specify an Echo input argument; for example:

<Echo>Off</Echo>

The Echo value is case-sensitive and is used to indicate whether a Web services transaction is to trigger the creation of an integration event (assuming that a workflow and integration event action have been configured to capture that particular transaction type). The default value of Echo is On, therefore when this parameter is provided in the request with a value of On, or is not included in the request, the integration event action is triggered and the transaction is recorded. When the Echo parameter is included with a value of Off, the transaction is not recorded.

Note: For Java users, the Echo string is required for all input methods. The echo string can be set to Off.

The ViewMode Argument

The ViewMode argument is an input argument for all of the Web Services v2.0 API methods. It applies to parent objects only, and specifies the level of access to parent records identified in the method call. ViewMode can take one of the following values:

• ManagerBooks. Provides access to the same set of records that are returned when Manager Visibility is enabled in the company profile and ViewMode is set to AllBooks.

• Manager. Provides access to records for which the current user or a subordinate of the current user owns the records, or is part of the team that owns the records.

• EmployeeManager. Provides access to records for which the current user or a subordinate of the current user owns the records. This value is similar to Manager, but teams are not considered.

• Sales Rep. Provides access to records for which the current user is part of the team that owns the records.

• Personal. Provides access to records owned by the user.

• Organization. Provides access to records within the current user's organization.

• Broadest. Provides access to the maximum set of records allowed for the user. This is the default value.

• AllBooks. For objects that support book, provides access to all books. This value is similar to Broadest, and works like All+ with the Book Selector in the Oracle CRM On Demand UI.

• Context. For objects that support books, provides access to the default book. For access to a specific book, the QueryPage method must use the BookId and BookName arguments.

The order of preference from most restrictive to least restrictive is:

• Personal

• Sales Rep

• Organization

Performance might be improved when a restricted set of records is accessed.

The LOVLanguageMode Argument

The LOVLanguageMode argument is an input argument for all of the Web Services v2.0 API methods. It determines whether the processing for picklist fields occurs using language independent codes (LIC) or language dependent codes (LDC). The argument is applicable only to simple picklist fields (which have an Edit Picklist link in the Field Setup page in the Oracle CRM On Demand application).

The LOVLanguageMode argument can take one of two values: LIC or LDC. LIC is the default value.

For methods other than QueryPage:

• If LIC is specified, then Web Services On Demand expects LIC values and converts them to LDV (based on the user’s current setting) and performs the processing.

• If LDC is specified, no translation is performed and values are expected to be in the user’s language.

For the QueryPage method:

• If LIC is specified in the query, the response contains picklist fields with language independent values.

• If LDC is specified in the query, the response contains picklist values in the user’s language.

The Field-level Replace Operation

For the Web Services v2.0 Update and Execute method calls you can specify the operation attribute with the value "replace" on reference ID fields. Requests that include this attribute remove the existing association between the parent and the referenced record and create a new association with a specified record. An example of such a request is as follows:

<CampaignUpdate_Input xmlns="urn:crmondemand/ws/ecbs/Campaign/">
	<ListOfCampaign>
		<Campaign>
			<Id>1-FRW01</Id>
			<CustomObject1Id operation=”replace”>1QA2-LVL4X</CustomObject1Id>
		</Campaign>
	</ListOfCampaign>
</CampaignUpdate_Input>

In this example, the existing association between the campaign parent and the custom object child record is replaced with an association between the campaign parent and the custom object record with the ID: 1QA2-LVL4X.

The list of objects and reference ID fields that support the replace operation in the current release is shown in the following table.

Table Objects and Fields That Support the Replace Operation

Object	Reference ID Fields
Account	CustomObject1Id, CustomObject2Id, CustomObject3Id, PrimaryContactId
Activity	CustomObject1Id, CustomObject2Id, CustomObject3Id, PrimaryContactId
Campaign	CustomObject1Id, CustomObject2Id, CustomObject3Id
Contact	CustomObject1Id, CustomObject2Id, CustomObject3Id
Custom Object 1, Custom Object 2, Custom Object 3	AccountId, ActivityId, AssetId, CampaignId, ContactId, CustomObject1Id, CustomObject2Id, CustomObject3Id, DealerId, FundId, FundRequestId, HouseholdId, LeadId, MedEdId, OpportunityId, PortfolioId, ProductId, ServiceRequestId, SolutionId, VehicleId
Custom Object 1 child, Custom Object 2 child, Custom Object 3 child	AccountId, CampaignId, ContactId, CustomObject1Id, CustomObject2Id, CustomObject3Id, DealerId, FundId, HouseholdId, LeadId, MedEdId, OpportunityId, PortfolioId, ProductId, ServiceRequestId, SolutionId, VehicleId
Dealer	CustomObject1Id, CustomObject2Id, CustomObject3Id
Fund	CustomObject1Id, CustomObject2Id, CustomObject3Id
Fund Request	CustomObject1Id, CustomObject2Id, CustomObject3Id
Household	CustomObject1Id, CustomObject2Id, CustomObject3Id
Lead	CustomObject1Id, CustomObject2Id, CustomObject3Id
MedEdEvent	CustomObject1Id, CustomObject2Id, CustomObject3Id
Opportunity	CustomObject1Id, CustomObject2Id, CustomObject3Id
Partner	CustomObject1Id, CustomObject2Id, CustomObject3Id
Portfolio	CustomObject1Id, CustomObject2Id, CustomObject3Id
Portfolio child	CustomObject1Id, CustomObject2Id, CustomObject3Id
Service Request	CustomObject1Id, CustomObject2Id, CustomObject3Id
Solution	CustomObject1Id, CustomObject2Id, CustomObject3Id
Vehicle	CustomObject1Id, CustomObject2Id, CustomObject3Id

Changes to WSDL Files

To enable the field-level replace operation, the data types for many elements in WSDL files were changed from the string to OperationData data type in Oracle CRM On Demand Release 26.

For example, in the Web services v2.0 WSDL file for Service Request in Release 25:

<xsd:element name="CustomObject1Id" maxOccurs="1" minOccurs="0" type="xsd:string" /> 

and for the WSDL for Service Request in Release 26 and later:

<xsd:element name="CustomObject1Id" maxOccurs="1" minOccurs="0" 
type="xsdLocal1:OperationData" />

The definition of the OperationData type is as follows:

<xsd:complexType name="OperationData">
  <xsd:simpleContent>
    <xsd:extension base="xsd:string">
      <xsd:attribute name="operation" type="xsd:string" /> 
    </xsd:extension>
  </xsd:simpleContent>
</xsd:complexType>

This change will not regress existing proxy classes and integrations generated using WSDL files from before Release 26. However, if you are planning to generate fresh proxy classes from WSDL files from Release 26 and later, you must enhance your integration to use the OperationData data type.

Also, note that upgraded Release 26 proxies and updated integrations will be able to consume the OperationData data type value against a Release 25 environment only if the replace functionality is not used. In other words, you cannot use the operation attribute against an environment based on an older release than Release 26.

Delete

Removes records of a specified record type from the Oracle CRM On Demand database.

Usage

You use the Delete method to remove one or more records of a particular object from an Oracle CRM On Demand instance.

The deleted records appear in the Deleted Items folder and can be restored through the Oracle CRM On Demand UI.

The Delete call can be used to delete both parent record and child records. If the child node specified in the request is available, it deletes the child in the existing parent record, and leaves the parent record undeleted. However, if the child node is missing, it deletes the existing parent record.

The AvailableForBatchRestore Argument

In Delete requests you can set the AvailableForBatchRestore argument to true and for record types that support batch delete and restore in the UI, you can then restore deleted records as a batch in the UI. When the request is executed, a batch delete record is created and displayed in the Batch Delete and Restore Queue page. Users with the Batch Delete and Restore privilege can then restore the records.

When the AvailableForBatchRestore argument is set to true, the Web services operation count is doubled for the request. This is because there is one operation for each deleted record and one operation due to the creation of a batch delete record.

When the AvailableForBatchRestore argument is set to false or not provided in the Delete request, a batch delete record is not created, and you cannot restore the deleted records as a batch in the Batch Delete and Restore Queue page. You can, however, still restore the deleted records individually in the UI.

For Delete requests containing a mixture of parent records and child records, only the records that support batch delete and restore in the UI are added to the queue. Separate batch delete records are created for each child record type. For child records, you can only use the AvailableForBatchRestore argument if the child record has a 1:M relationship with the parent record type. For example, deleted Account Lead records can be batch restored, because there is a 1:M relationship between leads and accounts.

Note: If a child record does not have a 1:M relationship with the parent, or does not support batch delete and restore, the delete functionality still works but the batch delete record is not displayed in the Batch Delete and Restore Queue page, even if the argument is set to true.

For Delete requests that include some record types that do not support batch delete and restore, the AvailableForBatchRestore argument is ignored for those record types, but the request executes without error for records types that do support batch delete and restore.

For more information about restoration of batches of records in the UI, see Oracle CRM On Demand Online Help.

Arguments

The following table describes the arguments taken by the Delete method.

Table Arguments Taken by the Delete Method

Name	Description	Required	Default	I/O
ListOf(Object). For example, ListOfAccount	The list of object instances to be deleted.	Yes	Not applicable	Input/Output
LOVLanguageMode	The language mode for picklists, see The LOVLanguageMode Argument.	No	LIC	Input
Echo	Controls whether data sent to Oracle CRM On Demand through integration Web services are recorded as transactions.	No	On	Input
ViewMode	Specifies the level of access to records specified in the method call, see The ViewMode Argument.	No	Broadest	Input
AvailableForBatchRestore	Controls whether the request will be available for batch restore in the Batch Delete and Restore Queue page in the UI.	No	False	Input

Return Value of the Call

The status key for each of the deleted objects.

Sample SOAP Request - Delete

The following SOAP request contains two contact records, one of which specifies a parent contact record and one of its child account records, while the other only specifies a parent contact record. When a child record is included in the request, the parent record is ignored and only the specified child record is deleted, whereas when no child record is included in the request, the parent record is deleted.

The contact ID is specified as the user key to identify the contact records in the request. See Contact for a list of valid user key field combinations for the contact object.

<?xml version="1.0" encoding="utf-8" standalone="no"?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" 
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:wsse="http://docs.oasis-
open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd" xmlns:xsd="http://
www.w3.org/2001/XMLSchema">
<soap:Header>
<wsse:Security>
<wsse:UsernameToken>
   <wsse:Username>%%USERNAME%%</wsse:Username>
   <wsse:Password Type="http://docs.oasis-open.org/wss/2004/01/oasis-200401-
wss-username-token-profile-1.0#PasswordText">%%PASSWORD%%</wsse:Password>
</wsse:UsernameToken>
</wsse:Security>
</soap:Header>
<soap:Body>
<ContactDelete_Input xmlns="urn:crmondemand/ws/ecbs/contact/">
<ListOfContact>
   <Contact>
      <Id>ADSA-96IZCS</Id>
      <ListOfAccount>
         <Account>
            <AccountName>A1</AccountName>
            <AccountLocation>HQ</AccountLocation>
         </Account>
      </ListOfAccount>
   </Contact>
   <Contact>
      <Id>ADSA-96J5ZL</Id>
   </Contact>
</ListOfContact>
</ContactDelete_Input>
</soap:Body>
</soap:Envelope>

Sample SOAP Response

The following SOAP response contains the returned status keys for the deleted objects:

<?xml version="1.0" encoding="utf-8"?>
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" 
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/
2001/XMLSchema">
<SOAP-ENV:Body>
<ns:ContactDelete_Output xmlns:ns="urn:crmondemand/ws/ecbs/contact/">
<ListOfContact xmlns="urn:/crmondemand/xml/Contact/Data">
   <Contact>
      <ModifiedDate>2011-08-10T15:21:43Z</ModifiedDate>
      <CreatedDate>2011-08-09T21:17:05Z</CreatedDate>
      <ModifiedById>HRZ780-I5RUE</ModifiedById>
      <CreatedById>HRZ780-I5RUE</CreatedById>
      <ModId>4</ModId>
      <Id>ADSA-96IZCS</Id>
      <CreatedBy>Joanne Brown, 08/09/2011 16:17:05</CreatedBy>
      <ModifiedBy>Joanne Brown, 08/10/2011 10:21:43</ModifiedBy>
      <ListOfAccount>
         <Account>
            <ModifiedDate>2011-08-10T14:44:27Z</ModifiedDate>
            <CreatedDate>2011-08-10T14:44:27Z</CreatedDate>
            <ModifiedById>HRZ780-I5RUE</ModifiedById>
            <CreatedById>HRZ780-I5RUE</CreatedById>
            <ModId>0</ModId>
            <Id>ADSA-977GCL</Id>
            <CreatedBy>Joanne Brown, 08/10/2011 09:44:27</CreatedBy>
            <ModifiedBy>Joanne Brown, 08/10/2011 09:44:27</ModifiedBy>
         </Account>
      </ListOfAccount>
   </Contact>
   <Contact>
      <ModifiedDate>2011-08-10T15:22:46Z</ModifiedDate>
      <CreatedDate>2011-08-09T21:13:33Z</CreatedDate>
      <ModifiedById>HRZ780-I5RUE</ModifiedById>
      <CreatedById>HRZ780-I5RUE</CreatedById>
      <ModId>2</ModId>
      <Id>ADSA-96J5ZL</Id>
      <CreatedBy>Joanne Brown, 08/09/2011 16:13:33</CreatedBy>
      <ModifiedBy>Joanne Brown, 08/10/2011 10:22:46</ModifiedBy>
   </Contact>
</ListOfContact>
</ns:ContactDelete_Output>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>

Execute

Executes multiple insert, delete, or update operations on separate records within a single Web services request.

Usage

You use the Execute method to perform different operations on records within the same Web services request for a single object.

The operations are defined by the operation attribute on the object element in the SOAP request, for example:

<Account operation="insert">

specifies an insert operation for an account object.

The operation attribute can have one of the following values:

• update. Updates the specified record

• insert. Inserts the specified record.

• delete. Deletes the matching record.

• skipnode. Skips the parent object and processes the child objects.

Every object specified in the call requires one valid operation. Mixed node operations are allowed for the Execute method.

Arguments

The following table describes the arguments taken by the Execute method.

Table Arguments Taken by the Execute Method

Name	Description	Required	Default	I/O
ListOf(Object). For example, ListOfAccount	The list of object instances to be inserted, deleted, or updated.	Yes	Not applicable	Input/Output
LOVLanguageMode	The language mode for picklists, see The LOVLanguageMode Argument.	No	LIC	Input
ViewMode	Specifies the level of access to records specified in the method call, see The ViewMode Argument.	No	Broadest	Input
Echo	Controls whether data sent to Oracle CRM On Demand through integration Web services are recorded as transactions.	No	On	Input

Return Value of the Call

The status key for each of the Oracle CRM On Demand objects.

Sample SOAP Request - Execute

The following SOAP request performs Execute operations for four separate contact records in a single Web service request. The first operation inserts a record, the second updates, the third deletes, and the final operation ignores the parent contact record and performs an update on the activity child record.

The ContactFirstName and ContactLastName is specified as the user key to identify the contact records in the request. See Contact for a list of valid user key field combinations for the contact object.

Note: For operations delete or update, if there are multiple records in Oracle CRM On Demand with the same ContactFirstName and ContactLastName, the request fails with a multiple match error. It is recommended to use the ID user key field to uniquely identify records as it avoids multiple match errors and also improves performance.

<?xml version="1.0" encoding="utf-8" standalone="no"?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/
XMLSchema-instance" xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-
secext-1.0.xsd" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
   <soap:Header>
      <wsse:Security>
         <wsse:UsernameToken>
            <wsse:Username>%%USERNAME%%</wsse:Username>
            <wsse:Password Type="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-username-token-profile-1.0#PasswordText">%%PASSWORD%%</wsse:Password>
         </wsse:UsernameToken>
      </wsse:Security>
   </soap:Header>
   <soap:Body>
      <ContactExecute_Input xmlns="urn:crmondemand/ws/ecbs/contact/">
         <ListOfContact>
            <Contact operation="insert">
               <ContactFirstName>NewCon5</ContactFirstName>
               <ContactLastName>NewCon5</ContactLastName>
            </Contact>
            <Contact operation="update">
               <ContactFirstName>Nathan</ContactFirstName>
               <ContactLastName>Lak</ContactLastName>
               <ContactEmail>[e-mail]</ContactEmail>
            </Contact>
            <Contact operation="delete">
               <ContactFirstName>NewCon5</ContactFirstName>
               <ContactLastName>Con5</ContactLastName>
            </Contact>
            <Contact operation="skipnode">
               <ContactFirstName>NewCon6</ContactFirstName>
               <ContactLastName>NewCon6</ContactLastName>
               <ListOfActivity>
                  <Activity operation="update">
                     <Subject>Subject 1</Subject>
                     <Activity>Task</Activity>
                     <Priority>1-High</Priority>
                  </Activity>
               </ListOfActivity>
            </Contact>
         </ListOfContact>
      </ContactExecute_Input>
   </soap:Body>
</soap:Envelope>

Sample SOAP Response

The following SOAP response contains the returned status keys for the contact objects:

<?xml version="1.0" encoding="utf-8"?>
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://
www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<SOAP-ENV:Body>
      <ns:ContactExecute_Output xmlns:ns="urn:crmondemand/ws/ecbs/contact/">
         <ListOfContact xmlns="urn:/crmondemand/xml/Contact/Data">
            <Contact>
               <ModifiedDate>2011-08-25T15:28:34Z</ModifiedDate>
               <CreatedDate>2011-08-25T15:28:34Z</CreatedDate>
               <ModifiedById>HRZ780-I5RUE</ModifiedById>
               <CreatedById>HRZ780-I5RUE</CreatedById>
               <ModId>0</ModId>
               <Id>ADSA-9HXB9V</Id>
               <CreatedBy>Joanne Brown, 08/25/2011 10:28:34</CreatedBy>
               <ModifiedBy>Joanne Brown, 08/25/2011 10:28:34</ModifiedBy>
            </Contact>
            <Contact>
               <ModifiedDate>2011-08-25T15:28:36Z</ModifiedDate>
               <CreatedDate>2011-08-04T17:01:41Z</CreatedDate>
               <ModifiedById>HRZ780-I5RUE</ModifiedById>
               <CreatedById>HRZ780-I5RUE</CreatedById>
               <ModId>5</ModId>
               <Id>ADSA-93DZIC</Id>
               <CreatedBy>Joanne Brown, 08/04/2011 12:01:41</CreatedBy>
               <ModifiedBy>Joanne Brown, 08/25/2011 10:28:36</ModifiedBy>
            </Contact>
            <Contact>
               <ModifiedDate>2011-08-12T15:11:17Z</ModifiedDate>
               <CreatedDate>2011-08-12T15:11:17Z</CreatedDate>
               <ModifiedById>HRZ780-I5RUE</ModifiedById>
               <CreatedById>HRZ780-I5RUE</CreatedById>
               <ModId>0</ModId>
               <Id>ADSA-98V4V7</Id>
               <CreatedBy>Joanne Brown, 08/12/2011 10:11:17</CreatedBy>
               <ModifiedBy>Joanne Brown, 08/12/2011 10:11:17</ModifiedBy>
            </Contact>
         </ListOfContact>
      </ns:ContactExecute_Output>
   </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

Insert

Inserts a new record in the Oracle CRM On Demand database.

Usage

You use the Insert method to create one or more records of a particular object in an Oracle CRM On Demand instance.

When inserting a batch of records, the batch is treated as a single transaction. If one record fails to insert during a batch insertion, the entire operation is rolled back and no records are inserted.

The Insert method can be used to insert both parent records and child records. If a child node is specified in the request, the Insert method inserts the child and associates it with the existing parent record. If a child node is missing, the Insert call inserts only the new parent record.

Insert calls must include values for fields that are required for the object. Fields can be conditionally required, that is they become required if the data specified for other fields on the record meets the criteria defined in an expression for the field. For more information about conditionally-required fields, see Oracle CRM On Demand Online Help.

Arguments

The following table describes the arguments taken by the Insert method.

Table Arguments Taken by the Insert Method

Name	Description	Required	Default	I/O
ListOf(Object). For example, ListOfAccount	The list of object instances to be inserted.	Yes	Not applicable	Input/Output
LOVLanguageMode	The language mode for picklists, see The LOVLanguageMode Argument.	No	LIC	Input
Echo	Controls whether data sent to Oracle CRM On Demand through integration Web services are recorded as transactions.	No	On	Input
ViewMode	Specifies the level of access to records specified in the method call, see The ViewMode Argument.	No	Broadest	Input

Return Value of the Call

The status key for each of the Oracle CRM On Demand objects.

Sample SOAP Request - Insert

The following SOAP request contains two contact records, one of which specifies a parent contact record and one of its child Account records, and the other only specifies a parent contact record. When a child record is included in the request, the parent record must exist in Oracle CRM On Demand and the child record specified is inserted and associated to the existing parent record. When no child record is included in the request, the parent record is inserted.

The ContactFirstName and ContactLastName are specified as the user key to identify the contact records in the request. See the fifth table under the topic Contact for a list of valid user key field combinations for the contact object.

<?xml version="1.0" encoding="utf-8" standalone="no"?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/
XMLSchema-instance" xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-
secext-1.0.xsd" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
   <soap:Header>
      <wsse:Security>
         <wsse:UsernameToken>
            <wsse:Username>%%USERNAME%%</wsse:Username>
            <wsse:Password Type="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-username-token-profile-1.0#PasswordText">%%PASSWORD%%</wsse:Password>
         </wsse:UsernameToken>
      </wsse:Security>
   </soap:Header>
   <soap:Body>
      <ContactInsert_Input xmlns="urn:crmondemand/ws/ecbs/contact/">
         <Echo>On</Echo>
         <LOVLanguageMode>LIC</LOVLanguageMode>
         <ListOfContact>
            <Contact>
               <ContactFirstName>NewCon2</ContactFirstName>
               <ContactLastName>Con2</ContactLastName>
               <ExternalSystemId>12345009</ExternalSystemId>
            </Contact>
            <Contact>
               <ContactFirstName>ExistingFirstName</ContactFirstName>
               <ContactLastName>ExistingLastName</ContactLastName>
               <ListOfAccount>
                  <Account>
                     <AccountName>Action Rentals</AccountName>
                  </Account>
               </ListOfAccount>
            </Contact>
         </ListOfContact>
       </ContactInsert_Input>
  </soap:Body>
</soap:Envelope>

Sample SOAP Response

The following SOAP response contains the returned status keys for the inserted objects:

<?xml version="1.0" encoding="utf-8"?>
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://
www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
   <SOAP-ENV:Body>
      <ns:ContactInsert_Output xmlns:ns="urn:crmondemand/ws/ecbs/contact/">
         <ListOfContact xmlns="urn:/crmondemand/xml/Contact/Data">
            <Contact>
               <ModifiedDate>2011-08-10T14:44:24Z</ModifiedDate>
               <CreatedDate>2011-08-10T14:44:24Z</CreatedDate>
               <ModifiedById>HRZ780-I5RUE</ModifiedById>
               <CreatedById>HRZ780-I5RUE</CreatedById>
               <ModId>0</ModId>
               <Id>ADSA-977GCJ</Id>
               <CreatedBy>Joanne Brown, 08/10/2011 09:44:24</CreatedBy>
               <ModifiedBy>Joanne Brown, 08/10/2011 09:44:24</ModifiedBy>
            </Contact>
            <Contact>
               <ModifiedDate>2011-08-10T14:41:55Z</ModifiedDate>
               <CreatedDate>2011-08-09T21:17:05Z</CreatedDate>
               <ModifiedById>HRZ780-I5RUE</ModifiedById>
               <CreatedById>HRZ780-I5RUE</CreatedById>
               <ModId>2</ModId>
               <Id>ADSA-96IZCS</Id>
               <CreatedBy>Joanne Brown, 08/09/2011 16:17:05</CreatedBy>
               <ModifiedBy>Joanne Brown, 08/10/2011 09:41:55</ModifiedBy>
               <ListOfAccount>
                  <Account>
                     <ModifiedDate>2011-08-10T14:44:27Z</ModifiedDate>
                     <CreatedDate>2011-08-10T14:44:27Z</CreatedDate>
                     <ModifiedById>HRZ780-I5RUE</ModifiedById>
                     <CreatedById>HRZ780-I5RUE</CreatedById>
                     <ModId>0</ModId>
                     <Id>ADSA-977GCL</Id>
                     <CreatedBy>Joanne Brown, 08/10/2011 09:44:27</CreatedBy>
                     <ModifiedBy>Joanne Brown, 08/10/2011 09:44:27</ModifiedBy>
                  </Account>
               </ListOfAccount>
            /Contact>
         </ListOfContact>
      </ns:ContactInsert_Output>
   </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

QueryPage

Executes a query against the set of records for an object, and returns the subset of the records that match the search criteria set by the method arguments.

Note: For fields of all data types apart from xsd:string, if the field has a blank or no value, it does not appear in the query response.

Team and Role Visibility Considerations

If a query includes a child object for which the user does not have access due to team or role visibility, then the child object returns no records.

Query by Template

To improve performance, the QueryPage result contains only those fields and objects that are included in the QueryPage request. To retrieve the values of fields that are not a part of the search criteria, the field must be included in the search request with a blank value.

Using the pagesize, startrownum, and recordcountneeded Arguments

The pagesize argument, which has a maximum value of 100, is used to specify the maximum number of records to be returned in a QueryPage response. The pagesize and startrownum arguments are specified as attributes of the ListOf(Object) element in requests, for example:

<ListOfAccount pagesize= "20 ' startrownum= "0 " recordcountneeded= "true ">

Depending on the value of pagesize, records are returned as follows:

• If the number of records in the record set is less than the pagesize value, the full record set is returned, and the lastpage attribute is set to true.

• If the number of records in the record set exceeds the pagesize value, only the number of records specified by the pagesize parameter is returned, and the lastpage attribute is false.

• For a query whose record set exceeds the pagesize value, setting the startrownum attribute to pagesize+1 (setting startrownum to pagesize returns the next pagesize number of records) returns the next pagesize number of records.

• If the size of the record set is greater than pagesize, and this is a subsequent query where there are less than pagesize number of records remaining to be returned, all of the remaining records are returned and lastpage attribute has a value of true.

Even though the QueryPage method returns a limited number of records, it keeps the data in the cache, which you can then retrieve by calling the QueryPage method again with a new value for the startrownum argument.

If you set the recordcountneeded argument to true, the record count is returned, except when the search specification includes calculated fields:

• If the QueryPage request contains filter criteria on a calculated field, or a calculated field is part of the value of the searchspec attribute, and there are records that match the given filter criteria, an error is thrown.

• If the QueryPage request contains filter criteria on a calculated field, or a calculated field is part of the value of the searchspec attribute, and there are no records that match the filter criteria (recordcount = "0" returned), no error is thrown.

Note: There is a performance impact if recordcountneeded is set to true, especially if the search specification contains calculated fields.

Using Search Specifications

You can use the searchspec argument of QueryPage to return only those records matching specified search criteria for an object. You can also specify the sort order and sort sequence for returned records using the sortorder and sortsequence arguments respectively. For more information, see Specifying the Sort Order and Sort Sequence.

The searchspec argument is specified as an attribute of an Object element in requests, for example:

<Contact searchspec= "[ContactFirstName] =  'Jo* ' ">

which would return only contact records for which the ContactFirstName field value begins with Jo. The search specification can be set on any field type. The query syntax is described in .

Tip: It is recommended to use a stateful rather than a stateless QueryPage Web service request, if it is required to paginate through a snapshot of data. However, if you do use a stateless request, it is recommended to use sort criteria to reduce the possibility of returning the same record when paging through results using the QueryPage method. For more information, see Use Sort Criteria when Using QueryPage.

Query Syntax

The query syntax for the searchspec argument supports only a small subset of binary and unary operators. No Siebel Query Language constructs or functions are supported. The query syntax is summarized in the following table.

Table Query Syntax for Query Page

Syntax Type	Notes
expression
[XML Tag] {Operator} {Value}	Operator can be binary or unary. The {Value} need only be specified for binary operators.
(expression) conjunction (expression)	A conjugated expression must be enclosed in parentheses to avoid ambiguity. However, nonconjugated expressions must not be enclosed in parentheses.
conjunction
OR	None
AND	None
unary operator
IS NULL	Used to find a match for a value that has no value
IS NOT NULL	None
EXISTS	See The EXISTS and NOT EXISTS Operators
NOT EXISTS	None
binary operator
=	None
~=	Denotes a case-insensitive exact search (no wildcards used)
<	Must be specified as &lt; to ensure well-formed XML.
<=	Must be specified as &lt;=
>	None
>=	None
<>	Must be specified as &lt;>
LIKE	Wildcard characters are treated as such only in the context of the operator LIKE.
~LIKE	Denotes a case-insensitive wildcard search
value
'literal'	Literal data is always enclosed in single quotes. To use a single quote within a literal, place another single quote immediately beside that quote. In this way, the query recognizes the quote as a literal and not as an operator. For example, the string ab'c is specified as ab''c. To use the special characters such as asterisk (*), question mark (?), and backslash (\) in queries, preceded them with the \ character. For example, to use the ? wildcard operator in a query, precede it with the \ character as follows: \?

Caution: Queries that are case-insensitive or with leading wildcard characters will perform slowly and must only be used when necessary. In some cases, you can however use shadow fields, see Using Shadow Fields for Better Search Performance.

The following is an example from a request that follows the query syntax:

<Contact searchspec= "[ContactFirstName] =  'John ' ">

where XML Tag is Contact FirstName, the operator is = and the value is the literal value John.

An example of an expression with a conjunction is as follows:

<Contact searchspec= "[ContactFirstName] = 'Jane ' ) AND [ContactLastName] = 'Doe ' ")>

Examples of searchspec usage are given in the following table.

Table Searchspec Examples

Operator	Usage of searchspec in request	Description
Case Sensitive LIKE with * wildcard	<ListOfContact startrownum="0" pagesize="100" recordcountneeded="true"> <Contact searchspec="[ContactFirstName] LIKE 'Contact* '"> <ContactFirstName/> </Contact></ListOfContact>	Returns all contacts whose ContactFirstName value starts with "Contact" and ends with zero or more characters
Case Insensitive ~ LIKE with * wildcard	<ListOfContact><Contact searchspec="[ContactFirstName] ~LIKE 'Contact* '"> <ContactFirstName/> </Contact></ListOfContact>	Returns all contacts whose ContactFirstName value starts with, for example, "Contact" or "contact" or "CoNtAcT" and ends with zero or more characters
Case Sensitive LIKE with ? wildcard	<ListOfContact><Contact searchspec="[ContactFirstName] LIKE 'Contact??? '"> <ContactFirstName/> </Contact></ListOfContact>	Returns all contacts whose ContactFirstName value starts with "Contact" and ends with any three characters
Case Insensitive ~ LIKE with ? wildcard	<ListOfContact><Contact searchspec="[ContactFirstName] ~LIKE 'Contact??? '"> <ContactFirstName/> </Contact></ListOfContact>	Returns all contacts whose ContactFirstName value starts with, for example, "Contact" or "contact" or "CoNtAcT", and ends with any three characters
Case Sensitive =	<ListOfContact><Contact searchspec="[ContactFirstName] = 'ContactInsert '"> <ContactFirstName/> </Contact></ListOfContact>	Returns all contacts whose ContactFirstName value is equal to "ContactInsert"
Case Insensitive ~=	<ListOfContact><Contact searchspec="[ContactFirstName] ~= 'ContactInsert '">' <ContactFirstName/> </Contact></ListOfContact>	Returns all contacts whose ContactFirstName value is equal to, for example, "ContactInsert","contactinsert" or "CoNtAcTiNsErT"
IS NULL	<ListOfContact><Contact searchspec="[TEXTLG_000] IS NULL"> <ContactFirstName/> </Contact></ListOfContact>	Returns all contacts whose TEXTLG_000 value is NULL
IS NOT NULL	<ListOfContact><Contact searchspec="[TEXTLG_000] IS NOT NULL"> <ContactFirstName/> </Contact></ListOfContact>	Returns all contacts whose TEXTLG_000 value is not NULL
AND	<ListOfContact><Contact searchspec="[BOOL_000] = 'Y' AND [IndexedBoolean0] = 'N'"> <ContactFirstName/><IndexedBoolean0/> </Contact></ListOfContact> Or <ListOfContact> <Contact searchspec="[BOOL_000] = 'Y'"> <ContactFirstName/> <IndexedBoolean0>='N'</IndexedBoolean0> </Contact></ListOfContact> Or <ListOfContact><Contact> <ContactFirstName/> <BOOL_000>='Y'</BOOL_000> <IndexedBoolean0>='N'</IndexedBoolean0> </Contact></ListOfContact>	Returns all contacts whose BOOL_000 value is Y AND IndexedBoolean0 value is N
OR	<ListOfContact><Contact searchspec="[BOOL_000] = 'Y' OR [IndexedBoolean0] = 'N'"> <ContactFirstName/> <BOOL_000/> <IndexedBoolean0/> </Contact></ListOfContact>	Returns all contacts whose BOOL_000 value is Y OR IndexedBoolean0 value is N
> (greater than)	<ListOfContact><Contact searchspec="[IndexedNumber0] > '500'"> <ContactFirstName/> <IndexedNumber0/> </Contact></ListOfContact>	Returns all contacts whose IndexedNumber0 value is greater than 500
>= (greater than or equal to)	<ListOfContact><Contact searchspec="[IndexedNumber0] >= '500'"> <ContactFirstName/> <IndexedNumber0/> </Contact></ListOfContact>	Returns all contacts whose IndexedNumber0 value is greater than or equal to 500
< (less than)	<ListOfContact><Contact searchspec="[IndexedNumber0] < '500'"> <ContactFirstName/> <IndexedNumber0/> </Contact></ListOfContact>	Returns all contacts whose IndexedNumber0 value is less than 500
<= (less than or equal to)	<ListOfContact><Contact searchspec="[IndexedNumber0] <= '500'"> <ContactFirstName/> <IndexedNumber0/> </Contact></ListOfContact>	Returns all contacts whose IndexedNumber0 value is less than or equal to 500
<> (not equal to)	<ListOfContact><Contact searchspec="[IndexedNumber0] <> '500'"> <ContactFirstName/> <IndexedNumber0/> </Contact></ListOfContact>	Returns all contacts whose IndexedNumber0 value is not equal to 500

Using Shadow Fields for Better Search Performance

To provide better performance for case-insensitive wildcard searches, you can use shadow fields in search specifications for some record types. Shadow fields are predefined and are found in the WSDL file for each object for which they are supported.

Shadow fields add a suffix, _Shadow, to the actual field name. For example, for a Name field there would be a Name_Shadow field. Shadow fields always store their value in upper case, so, for example, if the Name field has the value Oracle, then the Name_Shadow field has the value ORACLE.

To perform case insensitive searches, you use the shadow field instead of the actual field. For example, instead of a searchspec like this:

searchspec="[Name] ~LIKE '%cle"

you can use the following searchspec including upper case characters for better performance:

searchspec="[Name_Shadow] LIKE '%CLE'"

The EXISTS and NOT EXISTS Operators

You can use the unary operators EXISTS and NOT EXISTS with the searchspec argument of the QueryPage operation for any multivalued field of objects supported for Web Services v2.0.

EXISTS and NOT EXISTS only work for multivalued fields and not on other fields, including multi-select picklists. Very few multivalued fields are available, but one example is the address fields on the Account and Contact parent objects. Multivalued fields contain data from multiple records, in the case of the address fields, multiple countries, counties, and so on.

EXISTS returns true if the field expression matches for at least one of the values of the multivalued field.

For example, to query for all contacts where any one of the values of the AlternateAddressExternalSystemId field for all associated addresses of Contact is XYZ:

<Contact searchspec="EXISTS ([AlternateAddressExternalSystemId] = 'XYZ')">

NOT EXISTS returns true if the field expression matches for none of the values of the multivalued field.

For example, to query for all contacts where none of the values of the AlternateAddressExternalSystemId field for all associated addresses of Contact is XYZ:

<Contact searchspec="NOT EXISTS ([AlternateAddressExternalSystemId] = 'XYZ')">

As another example, to query for all accounts where any one of the values of the PrimaryBillToCounty field is Suffolk and any one of the values of the Primary Bill To Street Address field contains Ipswich:

<Account searchspec="EXISTS ([PrimaryBillToCounty] = 'Suffolk' AND 
[PrimaryBillToStreetAddress] LIKE '%Ipswich%')

Specifying the Sort Order and Sort Sequence

You can specify the sort order and sort sequence for returned records using the sortorder and sortsequence arguments respectively.

The sortorder and sortsequence arguments are specified as attributes of a FieldName element in requests, for example:

<CampaignName sortorder= "ASC " sortsequence= "1 "/>

which specifies that the records returned are sorted on the CampaignName field in an ascending order.

The sortsequence argument is used to specify the order in which sorting is applied if a sortorder value is specified on more than one field, for example:

<CampaignName sortorder= "ASC " sortsequence= "1 "/>
<Status sortorder= "ASC " sortsequence= "2 "/>"

Examples of sortorder and sortsequence usage are given in the following table.

Note: The sortorder argument is not supported for fields of date type CLOB or BLOB. Such fields could be used with the searchpsec argument with a LIKE operator, however, for performance reasons, use of CLOB and BLOB fields even for filtering must be avoided.Using multiple sort criteria might affect query performance. Use it only when necessary.

Table Sortorder and sortsequence Examples

Sort type	Usage of sortoder and sortsequence	Description
Sort in ascending order	<ListOfContact startrownum="0" pagesize="100" recordcountneeded="true"> <Contact searchspec= "[ContactFirstName] LIKE 'Contact* ' "> <ContactLastName sortorder="ASC"></ ContactLastName> </Contact></ListOfContact>	Returns all contacts whose ContactFirstName value starts with "Contact" and ends with zero or more characters and sorts them by ContactLastName in ascending order
Sort in descending order	<ListOfContact startrownum="0" pagesize="100" recordcountneeded="true"> <Contact> <ContactLastName sortorder="DESC">~LIKE 'Contact*'</ContactLastName> </Contact></ListOfContact>	Returns all contacts whose ContactLastName value starts with "Contact" and ends with zero or more characters and sorts them by ContactLastName in descending order
Sort More than One Field	<ListOfContact startrownum="0" pagesize="100" recordcountneeded="true"> <Contact searchspec= "[ContactFirstName] LIKE 'Contact* ' "> <ContactLastName sortorder="DESC" sortsequence="1"></ContactLastName> <ContactFirstName sortorder="DESC" sortsequence="2"></ContactFirstName> <ExternalSystemId sortorder="DESC" sortsequence="3"></ExternalSystemId> </Contact></ListOfContact>	Returns all contacts whose ContactFirstName value starts with "Contact" and ends with zero or more characters and sorts them by ContactLastName in descending order and then by ContactFirstName in descending order and then by ExternalSystemId in descending order.

Specifying Books in Queries

For queries on record types that support books, you can use the BookId or BookName arguments to constrain the query to only the records in a particular book. For more information about the use of books, see Oracle CRM On Demand Online Help.

Querying Lists

You can use the optional NamedSearchSpec argument to query a list. NamedSearchSpec can specify the name of a System, Public or Private list, however, a user cannot specify the name of a list to which he or she does not have access in the UI.

The set of fields to be returned must be included in the SOAP request. The set of fields defined in the list as well as the sort order of the list are not used to define the response, however, the query uses the filter criteria defined in the UI for the list.

All languages are supported.

You can use NamedSearchSpec together with the searchspec argument to search within a list. In a QueryPage request when NamedSearchspec and field-level searchspecs are specified, an AND operation is performed between NamedSearchspec and the field-level searchspecs. For example, if the searchspec in a request is:

"[Field]=500"

and the value of NamedSearchSpec is:

([Field1] > 100 OR ([Field2] > 500 AND [Field 3] = true) AND [Field4] = 'MyName') AND 
[Field5] = 'Open'

then the effective searchspec is:

([Field]=500) AND (([Field1] > 100 OR ([Field2] > 500 AND [Field 3] = true) AND [Field4] 
= 'MyName') AND [Field5] = 'Open')

Specifying Proximity Search Parameters

In the Maps page in Oracle CRM On Demand you can perform a proximity search to check the addresses on records of a given record type to determine whether the addresses are within a specified radius of a selected location. Proximity searches are supported for the Account, Activity, and Contact record types. In the QueryPage methods for these record types, you must use the following arguments to specify the parameters for a proximity search:

• Latitude. The latitude value of the proximity search center.

• Longitude. The longitude value of the proximity search center.

• Radius. The radius of the proximity search. Possible values are: 1,5,10,20,25,50,100,500.

• Units. The unit of distance: Miles or Kilometers.

• AddressType. For the Account record type only, the address type for the proximity search:

  • BillingAddress. The proximity search for the account is limited to the billing address.

  • ShippingAddress. The proximity search for the account is limited to the shipping address.

    If the AddressType parameter is not provided or is empty, the proximity search is limited to the shipping address.

The namedsearchspec argument is used to define lists of records on which proximity searches can be made. If the arguments are missing or incorrect, an error message is received.

For more information about proximity searching, see Oracle CRM On Demand Online Help.

QueryPage Arguments

The following table describes the arguments taken by the QueryPage method.

Table Arguments Taken by the QueryPage Method

Name	Description	Required	Default	I/O
ListOf(Object). For example, ListOfAccount	The list of object instances queried (input), and after query execution, the list of object instances returned (output).	Yes	Not applicable	Input/Output
pagesize	The maximum number of records displayed on a page following a query.	No	10	Input
startrownum	Indicates the row from which the QueryPage method starts to return records. For example, if pagesize=100 and you want to return records 1-100, you set StartRowNum to 0. Then, if you want to return records 101-200, you set StartRowNum to 100, and run the query again. You continue doing this until the last page is returned. In this way, you can return all records for a particular query.	No	0	Input
recordcountneeded	Indicates whether a record count for the object is to be returned. Note: There is a performance impact if this argument is set to true. You cannot return a record count for requests in which the search specification contains calculated fields. For more information, see Using the pagesize, startrownum, and recordcountneeded Arguments.	No	false	Input
searchspec	Indicates the search specification for a field or for all the fields of an object.	No	Not applicable	Input
sortsequence	An integer value that determines the order of the sort specification.	No	Not applicable	Input
sortorder	Determines the sort order for the records returned by the query, either ASC for ascending or DESC for descending.	No	ASC	Input
NamedSearchSpec	Indicates the search specification for a named list for an object.	No	Not applicable	Input
LOVLanguageMode	The language mode for picklists, see The LOVLanguageMode Argument.	No	LIC	Input
ViewMode	Specifies the level of access to records specified in the method call, see The ViewMode Argument.	Yes	Broadest	Input
BookId	The book ID.	No	Not applicable	Input
BookName	The book name. This argument is ignored if a value for BookId is supplied.	No	Not applicable	Input
IncludeSubBooks	Whether subbooks are to be included.	No	False	Input

QueryPage Return Value of the Call

An object or list of objects of the type on which the method was called, with attributes as follows:

• LastPage. A Boolean value that indicates whether or not the last value in the query set has been returned.

• recordcount. An integer value that indicates the record count for the object. This value is only returned when recordcountneeded=true in the SOAP request.

QueryPage Sample SOAP Requests

This topic contains a number of sample SOAP requests and responses to illustrate the use of the QueryPage API.

Sample SOAP Request 1 - QueryPage with Field-level Filter

The following SOAP request queries for contact records that have a ContactType like 'Customer*'. It demonstrates the use of optional attributes at the List of objects level: pagesize, startrownum, and recordcountneeded, and the use of optional elements <ViewMode> and <LOVLanguageMode>.

<?xml version="1.0" encoding="utf-8" standalone="no"?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/
XMLSchema-instance" xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-
secext-1.0.xsd" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
   <soap:Header>
      <wsse:Security>
         <wsse:UsernameToken>
            <wsse:Username>%%USERNAME%%</wsse:Username>
            <wsse:Password Type="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-username-token-profile-1.0#PasswordText">%%PASSWORD%%</wsse:Password>
         </wsse:UsernameToken>
      </wsse:Security>
   </soap:Header>
   <soap:Body>
      <ContactQueryPage_Input xmlns="urn:crmondemand/ws/ecbs/contact/">
         <ViewMode>Personal</ViewMode>
         <LOVLanguageMode>LIC</LOVLanguageMode>
         <ListOfContact pagesize="100" startrownum="0" recordcountneeded="true">
            <Contact>
               <ContactFirstName/>
               <ContactLastName/>
               <ContactType>LIKE 'Customer*'</ContactType>
               <ContactEmail/>
               <ListOfActivity>
                  <Activity>
                     <Subject/>
                  </Activity>
               </ListOfActivity>
            </Contact>
         </ListOfContact>
      </ContactQueryPage_Input>
   </soap:Body>
</soap:Envelope>

Sample SOAP Response 1

The following SOAP response shows the list of 5 objects returned by SOAP request 1.

<?xml version="1.0" encoding="utf-8"?>
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://
www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
   <SOAP-ENV:Body>
      <ns:ContactQueryPage_Output xmlns:ns="urn:crmondemand/ws/ecbs/contact/">
         <ListOfContact xmlns="urn:/crmondemand/xml/Contact/Data" recordcount="5" lastpage="true">
            <Contact>
               <ContactEmail></ContactEmail>
               <ContactFirstName>D</ContactFirstName>
               <ContactLastName>Dan</ContactLastName>
               <ContactType>Customer</ContactType>
               <ListOfActivity lastpage="true">
                  <Activity>
                     <Subject>Send D Dan welcome email</Subject>
                  </Activity>
               </ListOfActivity>
            </Contact>
            <Contact>
               <ContactEmail></ContactEmail>
               <ContactFirstName>L</ContactFirstName>
               <ContactLastName>Lak</ContactLastName>
               <ContactType>Customer</ContactType>
               <ListOfActivity lastpage="true">
                  <Activity>
                     <Subject>Send L Lak welcome email</Subject>
                  </Activity>
               </ListOfActivity>
            </Contact>
            <Contact>
               <ContactEmail></ContactEmail>
               <ContactFirstName>NewCon6</ContactFirstName>
               <ContactLastName>Con6</ContactLastName>
               <ContactType>Customer</ContactType>
               <ListOfActivity lastpage="true">
                  <Activity>
                     <Subject>Add activity to C Contacts</Subject>
                  </Activity>
               </ListOfActivity>
            </Contact>
            <Contact>
               <ContactEmail>[e-mail]</ContactEmail>
               <ContactFirstName>Nathan</ContactFirstName>
               <ContactLastName>Lak</ContactLastName>
               <ContactType>Customer</ContactType>
               <ListOfActivity lastpage="true">
                  <Activity>
                     <Subject>Send Nathan Lak welcome email</Subject>
                  </Activity>
                  <Activity>
                     <Subject>Send Jordan Lak welcome email</Subject>
                  </Activity>
                  <Activity>
                     <Subject>Send J Lak welcome email</Subject>
                  </Activity>
                  <Activity>
                     <Subject>ActivityInsert Test R19</Subject>
                  </Activity>
                  <Activity>
                     <Subject>ActivityInsert Test R19 2</Subject>
                  </Activity>
                  <Activity>
                     <Subject>ActivityInsert Test R19 2</Subject>
                  </Activity>
               </ListOfActivity>
            </Contact>
            <Contact>
               <ContactEmail></ContactEmail>
               <ContactFirstName>NewCon5</ContactFirstName>
               <ContactLastName>NewCon5</ContactLastName>
               <ContactType>Customer</ContactType>
               <ListOfActivity lastpage="true"></ListOfActivity>
            </Contact>
         </ListOfContact>
      </ns:ContactQueryPage_Output>
   </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

Sample SOAP Request 2 - QueryPage with searchspec, sortsequence and sortorder Attributes

The following SOAP request queries for Contact records by specifying a search criterion with an OR conjunction in the searchspec attribute.

The samples also demonstrate use of the optional pagesize, startrownum, and recordcountneeded attributes at the <ListOfObject> level.

In SOAP request 2a, pagesize = 5 and startrownum = 0, this request returns the 5 records starting at row 0 (first record) that match the search criteria.

In SOAP request 2b, pagesize = 5 and startrownum = 5, this request returns the next 5 records starting at row 5 (sixth record) that match the search criteria.

In addition, the sample demonstrates the sortsequence and sortorder attributes at the element level to specify the sort order and sort sequence of the whole result set (including rows of records not returned due to the pagesize limit). Note that across both responses, (SOAP response 2a and SOAP response 2b), the records are sorted accordinh to the specified sort sequence and sort order.

Sample SOAP Request 2a

In this SOAP request, pagesize = 5 and startrownum = 0:

<?xml version="1.0" encoding="utf-8" standalone="no"?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/
XMLSchema-instance" xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-
secext-1.0.xsd" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
   <soap:Header>
      <wsse:Security>
         <wsse:UsernameToken>
            <wsse:Username>%%USERNAME%%</wsse:Username>
            <wsse:Password Type="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-username-token-profile-1.0#PasswordText">%%PASSWORD%%</wsse:Password>
         </wsse:UsernameToken>
      </wsse:Security>
   </soap:Header>
   <soap:Body>
      <ContactQueryPage_Input xmlns="urn:crmondemand/ws/ecbs/contact/">
         <ListOfContact pagesize="5" startrownum="0" recordcountneeded="true">
            <Contact searchspec="[ContactLastName] LIKE 'C*' OR [ContactType] = 'Customer'">
               <ContactFirstName></ContactFirstName>
               <ContactLastName sortorder="DESC" sortsequence="2"></ContactLastName>
               <ContactType sortorder="DESC" sortsequence="1"></ContactType>
            </Contact>
         </ListOfContact>
      </ContactQueryPage_Input>
   </soap:Body>
</soap:Envelope>

Sample SOAP Response 2a

The following SOAP response shows the list of 5 objects returned by SOAP request 2a:

<?xml version="1.0" encoding="utf-8"?>
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://
www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
   <SOAP-ENV:Body>
      <ns:ContactQueryPage_Output xmlns:ns="urn:crmondemand/ws/ecbs/contact/">
         <ListOfContact xmlns="urn:/crmondemand/xml/Contact/Data" recordcount="54" lastpage="false">
            <Contact>
               <ContactFirstName>James</ContactFirstName>
               <ContactLastName>Conners</ContactLastName>
               <ContactType>Prospect</ContactType>
            </Contact>
            <Contact>
               <ContactFirstName>Ruth</ContactFirstName>
               <ContactLastName>Chou</ContactLastName>
               <ContactType>Prospect</ContactType>
            </Contact>
            <Contact>
               <ContactFirstName>Jason</ContactFirstName>
               <ContactLastName>Cheney</ContactLastName>
               <ContactType>Prospect</ContactType>
            </Contact>
            <Contact>
               <ContactFirstName>Sean</ContactFirstName>
               <ContactLastName>Thomas</ContactLastName>
               <ContactType>Customer</ContactType>
            </Contact>
            <Contact>
               <ContactFirstName>Carlos</ContactFirstName>
               <ContactLastName>Santos</ContactLastName>
               <ContactType>Customer</ContactType>
            </Contact>
         </ListOfContact>
      </ns:ContactQueryPage_Output>
   </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

Sample SOAP Request 2b

In this SOAP request, pagesize = 5 and startrownum = 5

<?xml version="1.0" encoding="utf-8" standalone="no"?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/
XMLSchema-instance" xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-
secext-1.0.xsd" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
   <soap:Header>
      <wsse:Security>
         <wsse:UsernameToken>
            <wsse:Username>%%USERNAME%%</wsse:Username>
            <wsse:Password Type="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-username-token-profile-1.0#PasswordText">%%PASSWORD%%</wsse:Password>
         </wsse:UsernameToken>
      </wsse:Security>
   </soap:Header>
   <soap:Body>
      <ContactQueryPage_Input xmlns="urn:crmondemand/ws/ecbs/contact/">
         <ListOfContact pagesize="5" startrownum="5" recordcountneeded="true">
            <Contact searchspec="[ContactLastName] LIKE 'C*' OR [ContactType] = 'Customer'">
               <ContactFirstName></ContactFirstName>
               <ContactLastName sortorder="DESC" sortsequence="2"></ContactLastName>
               <ContactType sortorder="DESC" sortsequence="1"></ContactType>
            </Contact>
         </ListOfContact>
      </ContactQueryPage_Input>
   </soap:Body>
</soap:Envelope>

Sample SOAP Response 2b

The following SOAP response shows the list of 5 objects returned by the request in SOAP request 2b:

<?xml version="1.0" encoding="utf-8"?>
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://
www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
   <SOAP-ENV:Body>
      <ns:ContactQueryPage_Output xmlns:ns="urn:crmondemand/ws/ecbs/contact/">
         <ListOfContact xmlns="urn:/crmondemand/xml/Contact/Data" recordcount="54" lastpage="false">
            <Contact>
               <ContactFirstName>Nick</ContactFirstName>
               <ContactLastName>Ray</ContactLastName>
               <ContactType>Customer</ContactType>
            </Contact>
            <Contact>
               <ContactFirstName>Joanna</ContactFirstName>
               <ContactLastName>Pressman</ContactLastName>
               <ContactType>Customer</ContactType>
            </Contact>
            <Contact>
               <ContactFirstName>Marianne</ContactFirstName>
               <ContactLastName>Pok</ContactLastName>
               <ContactType>Customer</ContactType>
            </Contact>
            <Contact>
               <ContactFirstName>Brian</ContactFirstName>
               <ContactLastName>Pittenger</ContactLastName>
               <ContactType>Customer</ContactType>
            </Contact>
            <Contact>
               <ContactFirstName>Marie</ContactFirstName>
               <ContactLastName>Perkins</ContactLastName>
               <ContactType>Customer</ContactType>
            </Contact>
         </ListOfContact>
      </ns:ContactQueryPage_Output>
   </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

Sample SOAP Request 3 - QueryPage with NamedSearchSpec

The following SOAP request queries for contact records in a specific contact list by specifying the contact list name in the <NamedSearchSpec> element.

The following table shows the records in the C Contacts list from the Oracle CRM On Demand UI. There are a total of 11 records in the list, therefore the recordcount value returned in the SOAP response equals 11.

Table Example of Records in a Contact List

Row	Last Name	First Name	Contact Type	Owner Alias
0	Cuthbery	David	Customer	Donna Jones
1	Coxe	Robin	Customer	Donna Jones
2	Connolly	John	Customer	Jeff Smith
3	Connors	James	Prospect	Jeff Smith
4	Cone	Alexander	Customer	Ian McAllistair
5	Con6	NewCon6	Customer	Joanne Brown
6	Cohen	Adam	Customer	Ian McAllistair
7	Clatt	Mark	Customer	Donna Jones
8	Chu	Will	Customer	Jeff Smith
9	Chou	Ruth	Prospect	Donna Jones
10	Cheney	Jason	Prospect	Ian McAllistair

<?xml version="1.0" encoding="utf-8" standalone="no"?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/
XMLSchema-instance" xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-
secext-1.0.xsd" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
   <soap:Header>
      <wsse:Security>
         <wsse:UsernameToken>
            <wsse:Username>%%USERNAME%%</wsse:Username>
            <wsse:Password Type="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-username-token-profile-1.0#PasswordText">%%PASSWORD%%</wsse:Password>
         </wsse:UsernameToken>
      </wsse:Security>
   </soap:Header>
   <soap:Body>
      <ContactQueryPage_Input xmlns="urn:crmondemand/ws/ecbs/contact/">
         <NamedSearchSpec>C Contacts</NamedSearchSpec>
         <ListOfContact pagesize="5" startrownum="0" recordcountneeded="true">
            <Contact>
               <ContactFirstName />
               <ContactLastName />
               <ContactType />
            </Contact>
         </ListOfContact>
      </ContactQueryPage_Input>
   </soap:Body>
</soap:Envelope>

Sample SOAP Response 3

The following SOAP response shows the list of contacts returned by sample SOAP request 3.

<?xml version="1.0" encoding="utf-8"?>
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://
www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
   <SOAP-ENV:Body>
      <ns:ContactQueryPage_Output xmlns:ns="urn:crmondemand/ws/ecbs/contact/">
         <ListOfContact xmlns="urn:/crmondemand/xml/Contact/Data" recordcount="11" lastpage="false">
            <Contact>
               <ContactFirstName>David</ContactFirstName>
               <ContactLastName>Cuthbery</ContactLastName>
               <ContactType>Customer</ContactType>
            </Contact>
            <Contact>
               <ContactFirstName>Robin</ContactFirstName>
               <ContactLastName>Coxe</ContactLastName>
               <ContactType>Customer</ContactType>
            </Contact>
            <Contact>
               <ContactFirstName>John</ContactFirstName>
               <ContactLastName>Connolly</ContactLastName>
               <ContactType>Customer</ContactType>
            </Contact>
            <Contact>
               <ContactFirstName>James</ContactFirstName>
               <ContactLastName>Conners</ContactLastName>
               <ContactType>Prospect</ContactType>
            </Contact>
            <Contact>
               <ContactFirstName>Alexander</ContactFirstName>
               <ContactLastName>Cone</ContactLastName>
               <ContactType>Customer</ContactType>
            </Contact>
         </ListOfContact>
      </ns:ContactQueryPage_Output>
   </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

Update

Updates the selected record with the new values.

Usage

You use the Update method to update one or more records of a particular object in an Oracle CRM On Demand instance.

The Update method can be used to update parent records and child records. If a child node is specified in the request, the Update method updates the child in the existing parent record. If the child node is missing, the Update method updates only the existing parent record.

Note: If the administrator customizes a record type to add a required field, Oracle CRM On Demand does not check for the required field when existing records are updated. When you update the record without the required field through a Web services request, or merge it with a record that does not have the required field, the record is updated or merged without error. This is the intended behavior; when a field is made required, it is the responsibility of the administrator to update all existing records to populate the required field. When inserting new records however, Oracle CRM On Demand checks for the required field.

Arguments

The following table describes the arguments taken by the Update method.

Table Arguments Taken by the Update Method

Name	Description	Required	Default	I/O
ListOf(Object). For example, ListOfAccount	The object instance to be updated.	Yes	Not applicable	Input/Output
LOVLanguageMode	The language mode for picklists, see The LOVLanguageMode Argument.	No	LIC	Input
Echo	Controls whether data sent to Oracle CRM On Demand through integration Web services are recorded as transactions.	No	On	Input
ViewMode	Specifies the level of access to records specified in the method call, see The ViewMode Argument.	Yes	Broadest	Input

Return Value of the Call

The status key for the updated objects.

Sample SOAP Request - Update

The following SOAP request updates an existing contact record.

The ContactFirstName and ContactLastName are specified as the user key to identify the contact records in the request. See Contact for a list of valid user key field combinations for the contact object.

Note: If there are multiple records in Oracle CRM On Demand with the same ContactFirstName and ContactLastName, the update request fails with a multiple match error. It is recommended to use the ID user key field to uniquely identify records as it avoids multiple match errors and also improves performance.

<?xml version="1.0" encoding="utf-8" standalone="no"?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/
XMLSchema-instance" xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-
secext-1.0.xsd" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
   <soap:Header>
      <wsse:Security>
         <wsse:UsernameToken>
            <wsse:Username>%%USERNAME%%</wsse:Username>
            <wsse:Password Type="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-username-token-profile-1.0#PasswordText">%%PASSWORD%%</wsse:Password>
         </wsse:UsernameToken>
      </wsse:Security>
   </soap:Header>
   <soap:Body>
      <ContactUpdate_Input xmlns="urn:crmondemand/ws/ecbs/contact/">
         <Echo>On</Echo>
         <LOVLanguageMode>LIC</LOVLanguageMode>
         <ListOfContact>
            <Contact>
               <ContactFirstName>ExistingCon1</ContactFirstName>
               <ContactLastName>ExistingCon1</ContactLastName>
               <ContactEmail>[e-mail]</ContactEmail>
            </Contact>
         </ListOfContact>
      </ContactUpdate_Input>
   </soap:Body>
</soap:Envelope>

Sample SOAP Response

The following SOAP response contains the returned status keys for the updated objects:

<?xml version="1.0" encoding="utf-8"?>
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://
www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
   <SOAP-ENV:Body>
      <ns:ContactUpdate_Output xmlns:ns="urn:crmondemand/ws/ecbs/contact/">
         <ListOfContact xmlns="urn:/crmondemand/xml/Contact/Data">
            <Contact>
               <ModifiedDate>2011-08-10T16:42:36Z</ModifiedDate>
               <CreatedDate>2011-08-09T21:17:05Z</CreatedDate>
               <ModifiedById>HRZ780-I5RUE</ModifiedById>
               <CreatedById>HRZ780-I5RUE</CreatedById>
               <ModId>8</ModId>
               <Id>ADSA-96IZCS</Id>
               <CreatedBy>Joanne Brown, 08/09/2011 16:17:05</CreatedBy>
               <ModifiedBy>Joanne Brown, 08/10/2011 11:42:36</ModifiedBy>
            </Contact>
         </ListOfContact>
      </ns:ContactUpdate_Output>
   </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

Service API Calls

The Oracle CRM On Demand Web Services service methods are listed in the following table. The service methods are those methods that are not called on Oracle CRM On Demand record types. Instead, they are used to perform administrative tasks. The table also shows the Web service for each of the methods. You can download the WSDL file for each service from the Web Services Administration page in the Oracle CRM On Demand application.

Table Web Services On Demand Service Methods

Method Name	Web Service	Comments
AuditTrailQueryPage	Audit Trail	Gets records from the master audit trail.
AuthAuthorizationUser	Authorization	Authenticates the current user and returns information about the user's company and the privileges enabled for the user's role.
DeletedItemQueryPage	Deleted Item	Gets information about deleted items.
DeleteEvents	Integration Event	Deletes events from an integration event queue.
ExportWebServiceCreateExportRequest	Export	Creates an export request.
ExportWebServiceMonitorExportRequest	Export	Gets data about an export request.
ExportWebServiceRetrieveExportAttachment	Export	Gets an attachment for an export request.
GetEvents	Integration Event	Gets events from an integration event queue.
GetLists	Lists	Gets the set of lists for an object.
GetMapping	Mapping Service	Gets a list of the display names of fields for a particular record type and their associated XML tags.
GetPicklistValues	Picklist	Gets lists of picklist values.
GetServerTime	Time	Gets the server time.
HistoryDelete	History	Deletes records in the Recently Viewed applet in the Action bar.
HistoryInsertOrUpdate	History	Insert or updates records in the Recently Viewed applet in the Action bar.
HistoryQueryPage	History	Gets the set of records from the Recently Viewed applet in the Action bar.
LeadConvert	Lead Conversion	Converts leads.
LoginHistoryQueryPage	Login History	Gets information about user login history.
MergeRecords	Merge	Merges records.
MetadataChangeSummaryQueryPage	Metadata Change Summary	Gets a summary of changes to metadata.
SetPassword	Password	Sets the passwords of users who use Oracle CRM On Demand.
SetSessionTimeZone	Time	Sets the time zone for a session.
UpdatePicklist	Picklist	Updates picklist values.
UpdateCascadingPicklists	Picklist	Updates cascading picklist values.
UserUsageQueryPage	User Usage	Gets information about Web services utilization.

AuditTrailQueryPage

Returns records from the master audit trail.

Usage

You use the AuditTrailQueryPage method to execute a query against the master audit trail, and return a subset of the records that match the search criteria set by the method arguments.

The following are attributes of the <ListOfAuditTrail> element that you can specify:

• pagesize. Determines the maximum number of records displayed on a page following a query.

• startrownum. Indicates the row from which the AuditTrailQueryPage method starts to return records.

• recordcountneeded. Indicates whether a record count for the query is to be returned.

You can also use the searchspec attribute on the AuditTrail element to provide a search specification.

Each of the child elements of <ListOfAuditTrail> can have the following attributes:

• sortorder. Determines the sort order for the records returned by the query, either ASC for ascending or DESC for descending.

• sortsequence. An integer value that determines the order of the sort specification.

The following are attributes of the <AuditTrailData> element that can be returned:

• recordcount. An integer value that indicates the record count.

• lastpage. A value that indicates whether or not the last value in the query set has been returned.

If the Enable Audit Trail Fields to Respect User Locale company profile setting is selected, the audit trail field values returned are formatted according to the user’s locale for the following field types:

• Currency

• Date

• Datetime

• Integer

• Number

• Percent

• Phone

• Picklist

If the Enable Audit Trail Fields to Respect User Locale company profile setting is not selected, the audit trail field values returned are not formatted according to the locale of the user.

Arguments

The following table describes the arguments taken by the AuditTrailQueryPage method.

Table Arguments Taken by the AuditTrailQueryPage Method

Name	Description	Required	Default	I/O
ListOfAuditTrail	The list of audit trail entries queried (input), and after query execution, the list of audit trail entries returned (output).	Yes	Not applicable	Input/Output
NamedSearchSpec	Indicates the search specification for a named list for the audit trail.	No	Not applicable	Input
LOVLanguageMode	The language mode for the audit trail, see The LOVLanguageMode Argument.	No	LIC	Input
ViewMode	Specifies the level of access to records specified in the method call, see The ViewMode Argument.	Yes	Broadest	Input

Return Value of the Call

The following information is returned:

• Id. The table row ID.

• SourceType. A value that indicates whether the session was interactive or a Web services session.

• RecordType. The record type.

• RecordUpdatedDate. The date when the object was last updated.

• UserFirstName. The user’s first name.

• UserFullName. The user’s full name.

• UserID. The user's ID.

• UserLastName. The user’s last name.

• UserSignInID. The user's login ID.

• FieldName. The field modified in the object.

• RecordName. The name of the record.

• Operation. The type of change that was performed, for example, create, delete, or modify.

• SourceIPAddress. The IP address of the computer on which the change took place.

  Note: This value is returned only when this information is available.

• NewFieldValue. The new value of the field.

• OldFieldValue. The previous value of the field.

There are also various elements with names beginning with Created, Modified, and Updated that give information about who performed the create, modify, or update operation on the record.

Sample SOAP Request - AuditTrailQueryPage

The following SOAP request queries the audit trail. It demonstrates the use of the pagesize and startrownum attributes to return a specific number of records starting at a specific row. The searchspec attribute species that only records modified after a certain date and time are to be returned:

<?xml version="1.0" encoding="utf-8" standalone="no"?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/
XMLSchema-instance" xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-
secext-1.0.xsd" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
   <soap:Header>
      <wsse:Security>
         <wsse:UsernameToken>
            <wsse:Username>%%%USERNAME%%%</wsse:Username>
            <wsse:Password Type="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-username-token-profile-1.0#PasswordText">%%%PASSWORD%%%</wsse:Password>
         </wsse:UsernameToken>
      </wsse:Security>
   </soap:Header>
   <soap:Body>
      <AuditTrailQueryPage_Input xmlns="urn:crmondemand/ws/audittrail/">
         <ListOfAuditTrail startrownum="0" pagesize="100" recordcountneeded="true">
            <AuditTrail searchspec="[ModifiedDate] > '2013-06-02T07:52:59Z'">
               <ModifiedDate/>
               <CreatedDate/>
               <ModifiedById/>
               <CreatedById/>
               <ModId/>
               <Id/>
               <SourceType/>
               <RecordType/>
               <RecordUpdatedDate/>
               <UserFirstName/>
               <UserFullName/>
               <UserId/>
               <UserLastName/>
               <UserSignInId/>
               <FieldName/>
               <RecordName/>
               <Operation/>
               <SourceIPAddress/>
               <UpdatedByFirstName/>
               <UpdatedByLastName/>
               <UpdatedByUserSignInId/>
               <UpdatedByAlias/>
               <UpdatedByFullName/>
               <UpdatedByIntegrationId/>
               <UpdatedByExternalSystemId/>
               <UpdatedByEMailAddr/>
               <CreatedByFirstName/>
               <CreatedByLastName/>
               <CreatedByUserSignInId/>
               <CreatedByAlias/>
               <CreatedByFullName/>
               <CreatedByIntegrationId/>
               <CreatedByExternalSystemId/>
               <CreatedByEMailAddr/>
               <CreatedBy/>
               <ModifiedBy/>
               <NewFieldValue/>
               <OldFieldValue/>
            </AuditTrail>
         </ListOfAuditTrail>
      </AuditTrailQueryPage_Input>
   </soap:Body>
</soap:Envelope>

Sample SOAP Response

The following illustrates the SOAP response (most of the <AuditTrail> elements are omitted, as indicated by the ellipses (...)):

<?xml version="1.0" encoding="utf-8"?>
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://
www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
   <SOAP-ENV:Body>
      <ns:AuditTrailQueryPage_Output>
         <ListOfAuditTrail recordcount="24" lastpage="true">
            <AuditTrail>
               <ModifiedDate>2014-06-02T07:52:59Z</ModifiedDate>
               <CreatedDate>2014-06-02T07:52:59Z</CreatedDate>
               <ModifiedById>1-D5S9Z</ModifiedById>
               <CreatedById>1-D5S9Z</CreatedById>
               <ModId>0</ModId>
               <Id>1QA2-22RN1C</Id>
               <SourceType>UI</SourceType>
               <RecordType>Opportunity</RecordType>
               <RecordUpdatedDate>2014-06-02T07:52:58Z</RecordUpdatedDate>
               <UserFirstName>System</UserFirstName>
               <UserFullName>SystemAdmin</UserFullName>
               <UserId>1-D5S9Z</UserId>
               <UserLastName>Admin</UserLastName>
               <UserSignInId>[e-mail]</UserSignInId>
               <FieldName>Sales Stage - Translation</FieldName>
               <RecordName>Testing</RecordName>
               <Operation>Modify</Operation>
               <SourceIPAddress>12.168.23.232</SourceIPAddress>
               <UpdatedByFirstName>System</UpdatedByFirstName>
               <UpdatedByLastName>Admin</UpdatedByLastName>
               <UpdatedByUserSignInId>[e-mail]</UpdatedByUserSignInId>
               <UpdatedByAlias>System Admin Alias ([e-mail])</UpdatedByAlias>
               <UpdatedByFullName>System Admin</UpdatedByFullName>
               <UpdatedByIntegrationId>1-D5S9W</UpdatedByIntegrationId>
               <UpdatedByExternalSystemId/>
               <UpdatedByEMailAddr>[e-mail]</UpdatedByEMailAddr>
               <CreatedByFirstName>System</CreatedByFirstName>
               <CreatedByLastName>Admin</CreatedByLastName>
               <CreatedByUserSignInId>[e-mail]</CreatedByUserSignInId>
               <CreatedByAlias>System Admin Alias ([e-mail])</CreatedByAlias>
               <CreatedByFullName>System Admin</CreatedByFullName>
               <CreatedByIntegrationId>1-D5S9W</CreatedByIntegrationId>
               <CreatedByExternalSystemId/>
               <CreatedByEMailAddr>[e-mail]</CreatedByEMailAddr>
               <CreatedBy>System Admin, 06/02/2014 07:52:59</CreatedBy>
               <ModifiedBy>System Admin, 06/02/2014 07:52:59</ModifiedBy>
               <NewFieldValue>Short List</NewFieldValue>
               <OldFieldValue>Qualified Lead</OldFieldValue>
            </AuditTrail>
...
...
            <AuditTrail>
               <ModifiedDate>2014-06-02T08:06:10Z</ModifiedDate>
               <CreatedDate>2014-06-02T08:06:10Z</CreatedDate>
               <ModifiedById>1-D5S9Z</ModifiedById>
               <CreatedById>1-D5S9Z</CreatedById>
               <ModId>0</ModId>
               <Id>1QA2-22RN1L</Id>
               <SourceType>UI</SourceType>
               <RecordType>x</RecordType>
               <RecordUpdatedDate>2014-06-02T08:06:10Z</RecordUpdatedDate>
               <UserFirstName>System</UserFirstName>
               <UserFullName>System Admin</UserFullName>
               <UserId>1-D5S9Z</UserId>
               <UserLastName>Admin</UserLastName>
               <UserSignInId>[e-mail]</UserSignInId>
               <FieldName>Account/Audit Trail Item 2</FieldName>
               <RecordName>Administrator Owner Access Profile</RecordName>
               <Operation>Modify</Operation>
               <SourceIPAddress>12.168.23.232</SourceIPAddress>
               <UpdatedByFirstName>System</UpdatedByFirstName>
               <UpdatedByLastName>Admin</UpdatedByLastName>
               <UpdatedByUserSignInId>[e-mail]</UpdatedByUserSignInId>
               <UpdatedByAlias>System Admin Alias ([e-mail])</UpdatedByAlias>
               <UpdatedByFullName>System Admin</UpdatedByFullName>
               <UpdatedByIntegrationId>1-D5S9W</UpdatedByIntegrationId>
               <UpdatedByExternalSystemId/>
               <UpdatedByEMailAddr>[e-mail]</UpdatedByEMailAddr>
               <CreatedByFirstName>System</CreatedByFirstName>
               <CreatedByLastName>Admin</CreatedByLastName>
               <CreatedByUserSignInId>[e-mail]</CreatedByUserSignInId>
               <CreatedByAlias>System Admin Alias ([e-mail])</CreatedByAlias>
               <CreatedByFullName>System Admin</CreatedByFullName>
               <CreatedByIntegrationId>1-D5S9W</CreatedByIntegrationId>
               <CreatedByExternalSystemId/>
               <CreatedByEMailAddr>[e-mail]</CreatedByEMailAddr>
               <CreatedBy>System Admin, 06/02/2014 08:06:10</CreatedBy>
               <ModifiedBy>System Admin, 06/02/2014 08:06:10</ModifiedBy>
               <NewFieldValue>1</NewFieldValue>
               <OldFieldValue>-1</OldFieldValue>
            </AuditTrail>
         </ListOfAuditTrail>
      </ns:AuditTrailQueryPage_Output>
   </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

AuthAuthorizationUser

Authenticates the current user and returns information about the user's company and the list of privileges enabled for the user's role.

Usage

You use the AuthAuthorizationUser method to authenticate the current user and return information relevant to the user.

There are no input argument, the method simply authenticates the current user name and password, and returns the information for the authenticated user.

The optional SOAP header parameter <AuthenticateOnly> is intended for use only with the AuthAuthorizationUser method:

• Setting the <AuthenticateOnly> parameter to true and sending a subsequent request with security credentials results in the previous session being closed (that is, a logoff is performed), and a new session is created with the supplied credentials.

• If the SOAP header parameter <SessionKeepAlive> is set to true, and a subsequent request does not contain security credentials, the previous session remains open and the request will be considered authenticated.

Note: If both <AuthenticateOnly> and <SessionKeepAlive> are set to true, <AuthenticateOnly> takes precedence.

Arguments

The following table describes the arguments taken by the AuthAuthorizationUser method.

Table Arguments Taken by the AuthAuthorizationUser Method

Name	Description	Required	Default	I/O
AuthenticatedUser	Information about the authenticated user.	Not applicable	Not applicable	Output

Return Value of the Call

The following information is returned:

• UserId. The user ID of the authenticated user.

• TenantId. The tenant for the authenticated user (SYS_TENANT_ID).

• ListofPrivileges. The set of privileges that have been enabled for the user's role.

• OrganizationName. The company name for the user.

• Location. The location of the company.

• RoleId. The role ID for the user’s role.

• Role. The user’s role.

Sample SOAP Request - AuthAuthorizationUser

The following SOAP request invokes AuthAuthorizationUser. No arguments are required.

<?xml version="1.0" encoding="utf-8" standalone="no"?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/
XMLSchema-instance" xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-
secext-1.0.xsd" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
   <soap:Header>
      <wsse:Security>
         <wsse:UsernameToken>
            <wsse:Username>%%%USERNAME%%%</wsse:Username>
            <wsse:Password Type="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-username-token-profile-1.0#PasswordText">%%%PASSWORD%%%</wsse:Password>
         </wsse:UsernameToken>
      </wsse:Security>
   </soap:Header>
   <soap:Body>
      <AuthWS_AuthAuthorizationUser_Input xmlns="urn:crmondemand/ws/auth/" />
   </soap:Body>
</soap:Envelope>

Sample SOAP Response

The following illustrates the SOAP response (most of the <Privilege> elements are omitted as indicated by the ellipses (...)):

<?xml version="1.0" encoding="utf-8"?>
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://
www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
   <SOAP-ENV:Body>
      <ns:AuthWS_AuthAuthorizationUser_Output xmlns:ns="urn:crmondemand/ws/auth/">
         <AuthenticatedUser xmlns="urn:/crmondemand/xml/auth">
            <User>
               <UserId>1-CWTEQ</UserId>
               <TenantId>1-CWJ8T</TenantId>
               <OrganizationName>Farley 75</OrganizationName>
               <Location>Toronto</Location>
               <RoleId>1-CWJU5</RoleId>
               <Role>Vertical Admin</Role>
               <ListOfPrivileges>
                  <Privilege>
                     <PrivilegeName>FULL_ACCESS_ANALYTICS</PrivilegeName>YTICS</PrivilegeName>
                  </Privilege>
...
...
               </ListOfPrivileges>
            </User>
         </AuthenticatedUser>
      </ns:AuthWS_AuthAuthorizationUser_Output>
   </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

DeletedItemQueryPage

Returns details of deleted items.

Objects Supported

DeletedItemQueryPage is supported for all Web Services v1.0 and Web Services v2.0 accessible objects that can be deleted.

Usage

You use the DeletedItemQueryPage method to execute a query against the list of deleted records, and return a subset of the records that match the search criteria set by the method arguments.

The set of records returned is sorted by DeletedDate in ascending order (as shown in the response in Sample SOAP Request - DeletedItemQueryPage).

The Type of the DeletedItems object returned by the DeletedItemQueryPage method is not always the same as that used in the UI of the Oracle CRM On Demand application, as shown in the following table.

Note: In the following table, the * characters are asterisk characters, and do not represent wildcard characters.

You must use the types shown in the table in queries for deleted item records. (The type is language independent.)

Table Deleted Item Types Returned by DeletedItemQueryPage Method

UI Record Type	Deleted Item Type
Account	Account
Account Attachment	Account Attachment
Account Note	Account Note
Account Private Note	Account Private Note
Action Attachment	Action Attachment
Address	Address
Appointment	Action***Appointment
Asset	Asset Mgmt - Asset
Campaign	Campaign
Campaign Attachment	Campaign Attachment
Campaign Note	Campaign Note
Channel Partner	Channel Partner
Contact	Contact
Contact Attachment	Contact Attachment
Contact Interest	Contact Interests
Contact Note	Contact Note
Contact Private Note	Contact Private Note
Custom Object 01	OnDemand Custom Object 1
Custom Object 02	OnDemand Custom Object 2
Custom Object 03	OnDemand Custom Object 3
Custom Object n (where n = 04 and higher)	CustomObjectn (where n = 4 and higher)
Custom Object 01 Attachment	OnDemand Custom Object 1 Attachment
Custom Object 02 Attachment	OnDemand Custom Object 2 Attachment
Custom Object 03 Attachment	OnDemand Custom Object 3 Attachment
Custom Object 01 Note	OnDemand Custom Object 1 Note
Custom Object 02 Note	OnDemand Custom Object 2 Note
Custom Object 03 Note	OnDemand Custom Object 3 Note
Dealer Attachment	Dealer Attachment
Dealer Note	Dealer Note
Event	Pharma ME Event
Forecast Revenue	Forecast Revenue
Fund	Fund
Fund Attachment	Fund Attachment
Fund Note	Fund Note
Fund Request	Fund Request
Fund Request Attachment	Fund Request Attachment
Fund Request Note	Fund Request Note
Household	Household
Lead	Lead
Lead Attachment	Lead Attachment
Note	Note
Opportunity	Opportunity
Opportunity Attachment	Opportunity Attachment
Opportunity Note	Opportunity Note
Opportunity Private Note	Opportunity Private Note
Organization	Organization
Organizations Note	Organizations Note
Plan Account	CRMODLS_BPL_ACNT
Portfolio	VONDINS Portfolio***Portfolio
Portfolio Child	VONDINS Portfolio Child***Portfolio
Position	Position
Product Detailed	Pharma Call Product Detailed
Referral	VONDINS Referral***Referral
Revenue	Revenue
Sales Stage Attachment	Sales Stage Attachment
Sample Dropped	Pharma Call Sample Dropped
Service Request	Service Request
Service Request Attachment	Service Request Attachment
Service Request Note	Service Request Note
Smart Call	Pharma Template Call
Solution	Solution
Solution Attachment	Solution Attachment
Task	Action***Task
Vehicle	Auto Vehicle

Arguments

The following table describes the arguments taken by the DeletedItemQueryPage method.

Table Arguments Taken by the DeletedItemQueryPage Method

Name	Description	Required	Default	I/O
ListOfDeletedItem	The list of object instances queried (input), and after query execution, the list of object instances returned (output).	Yes	Not applicable	Input/Output
PageSize	The maximum number of records displayed on a page following a query.	No	10	Input
StartRowNum	Indicates the row from which the DeletedItemQueryPage method starts to return records. Use the StartRowNum argument to return a set of records for any given method. For example, if PageSize=100 and you want to return records 1-100, you set StartRowNum to 0. Then, if you want to return records 101-200, you set StartRowNum to 100, and run the query again. You continue doing this until the last page is returned. In this way, you can return all records for a particular query.	No	0	Input
LastPage	A value that indicates whether or not the last value in the query set has been returned.	Not applicable	Not applicable	Output

Return Value of the Call

The following information is returned for deleted items:

• DeletedItemId. The ID of the deleted item.

• DeletedById. The user ID of the user who deleted the item.

• DeletedBy. The name of the user who deleted the item.

• DeletedDate. The date on which the item was deleted.

• Name. The name of the deleted record.

• ObjectId. The object ID of the deleted record.

• Type. The type of the deleted record.

• ExternalSystemId. The external system ID of the item.

Sample SOAP Request - DeletedItemQueryPage

The following SOAP request queries the list of deleted items with the object type = "Contact". It demonstrates the use of the optional arguments <PageSize> and <StartRowNum> to return a specific number of records starting at a specific row.

<?xml version="1.0" encoding="utf-8" standalone="no"?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/
XMLSchema-instance" xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-
secext-1.0.xsd" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
   <soap:Header>
      <wsse:Security>
         <wsse:UsernameToken>
            <wsse:Username>%%%USERNAME%%%</wsse:Username>
            <wsse:Password Type="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-username-token-profile-1.0#PasswordText">%%%PASSWORD%%%</wsse:Password>
         </wsse:UsernameToken>
      </wsse:Security>
   </soap:Header>
   <soap:Body>
      <DeletedItemWS_DeletedItemQueryPage_Input xmlns="urn:crmondemand/ws/deleteditem/">
         <ListOfDeletedItem>
            <DeletedItem>
               <DeletedItemId />
               <DeletedById />
               <DeletedBy />
               <DeletedDate />
               <Name />
               <ObjectId />
               <Type>='Contact'</Type>
               <ExternalSystemId />
            </DeletedItem>
         </ListOfDeletedItem>
         <PageSize>3</PageSize>
         <StartRowNum>0</StartRowNum>
      </DeletedItemWS_DeletedItemQueryPage_Input>
   </soap:Body>
</soap:Envelope>

Sample SOAP Response

The following SOAP response contains three deleted contact records:

<?xml version="1.0" encoding="utf-8"?>
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://
www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
   <SOAP-ENV:Body>
      <ns:DeletedItemWS_DeletedItemQueryPage_Output xmlns:ns="urn:crmondemand/ws/deleteditem/">
         <ns:LastPage>true</ns:LastPage>
         <ListOfDeletedItem xmlns="urn:/crmondemand/xml/deleteditem">
            <DeletedItem>
               <DeletedItemId>ADSA-921PLC</DeletedItemId>
               <DeletedBy>Joanne Brown</DeletedBy>
               <DeletedById>HRZ780-I5RUE</DeletedById>
               <DeletedDate>08/02/2011 15:19:24</DeletedDate>
               <Name>Person One</Name>
               <ObjectId>ADSA-921PL5</ObjectId>
               <Type>Contact</Type>
               <ExternalSystemId></ExternalSystemId>
            </DeletedItem>
            <DeletedItem>
               <DeletedItemId>ADSA-93EVML</DeletedItemId>
               <DeletedBy>Joanne Brown</DeletedBy>
               <DeletedById>HRZ780-I5RUE</DeletedById>
               <DeletedDate>08/04/2011 12:16:39</DeletedDate>
               <Name>Jordan Lak</Name>
               <ObjectId>ADSA-93EGXJ</ObjectId>
               <Type>Contact</Type>
               <ExternalSystemId>ABC321</ExternalSystemId>
            </DeletedItem>
            <DeletedItem>
               <DeletedItemId>ADSA-93EVFP</DeletedItemId>
               <DeletedBy>Joanne Brown</DeletedBy>
               <DeletedById>HRZ780-I5RUE</DeletedById>
               <DeletedDate>08/04/2011 12:20:44</DeletedDate>
               <Name>J Lak</Name>
               <ObjectId>ADSA-93ET5I</ObjectId>
               <Type>Contact</Type>
               <ExternalSystemId>abc223</ExternalSystemId>
            </DeletedItem>
         </ListOfDeletedItem>
      </ns:DeletedItemWS_DeletedItemQueryPage_Output>
   </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

DeleteEvents

Deletes events from an integration event queue.

Objects Supported

DeleteEvents is supported for all objects that use Web Services v2.0 Schema and the following objects that use Web Services v1.0 Schema:

Account, Account Competitor, Account Contact, Account Contact Role, Account Note, Account Team, Activity, Activity Attachment, Asset, Call PromItemDrop, Call SampleDropped, Campaign, Contact, Contact Campaign, Contact Interests, Contact Note, Contact Team, Custom Object 01 - 03, Custom Object 01 - 03 Team, Dealer, Event Household, Household Contact, HouseholdTeam, Lead, Lead Team, Opportunity, Opportunity Competitor, Opportunity Contact Role, Opportunity Note, Opportunity Partner, Opportunity Team, Portfolio, Portfolio Owner, PortfolioTeam, Product, ProductCategory, Program, Program Partner, Service Request, Service Request Note, Service Request Team, Solution, Territory, Vehicle.

Usage

You use the DeleteEvents method of the Integration Event Web service to delete events from an integration event queue. Integration events are actions that are triggered based on meeting certain workflow criteria. An integration event stores information about data that has changed:

• User key information about the changed record, for example: objectID, externalsystemID

• Audit information, for example, created date, createdby, modified date, modified by

Integration events are stored in one or more company queues on the hosted environment. The maximum number of events in the queues is set by Customer Care. Contact Customer Care to request support for the Integration Event Web Service and to specify the maximum total size of the integration queues you require. For more information about integration events and setting up workflow criteria, see Oracle CRM On Demand Online Help.

The QueueName argument, if specified, must match the name of a queue defined for a company within Oracle CRM On Demand. The QueueName value is the localized display name value for the user. If the supplied name is not valid, an error message is returned.

If QueueName is not specified, the value is empty, or if the value is Default Queue, events are deleted from the default queue.

If the DateTime argument is supplied, all events older than the specified date and time are deleted. If the LastEventId argument is supplied, all events older than the specified event are deleted. If DateTime and LastEventId are not specified, all events are deleted from the queue.

If a valid queue name is provided but the LastEventId value provided does not match an event in that queue, an error is returned.

When there is a pending request to a queue, another call to the same queue cannot be invoked until the previous request completes. However, another call to a different queue can be invoked before the previous request completes.

You can delete events for all of the supported record types, or a subset of record types, depending on how you prepare the WSDL and Schema files associated with the Integration Event service, see Preparing the Integration Event WSDL File and Schema Files.

Arguments

The following table describes the arguments taken by the DeleteEvents method.

Table Arguments Taken by the Delete Events Method

Name	Description	Required	Default	I/O
QueueName	The name of the integration event queue.	No	Default Queue	Input/Output
DateTime	A date and time.	No	Not applicable	Input
LastEventId	An event ID	No	Not applicable	Input/Output

Return Value of the Call

The ID of the last event deleted.

Sample SOAP Request - DeleteEvents

The following SOAP request deletes events from the queue specified. If both the <LastEventId> and <DateTime> arguments are supplied, the <LastEventId> is used to determine which events to delete.

<?xml version="1.0" encoding="utf-8" standalone="no"?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/
XMLSchema-instance" xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-
secext-1.0.xsd" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
   <soap:Header>
      <wsse:Security>
         <wsse:UsernameToken>
            <wsse:Username>%%%USERNAME%%%</wsse:Username>
            <wsse:Password Type="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-username-token-profile-1.0#PasswordText">%%%PASSWORD%%%</wsse:Password>
         </wsse:UsernameToken>
      </wsse:Security>
   </soap:Header>
   <soap:Body>
      <IntegrationEventWS_DeleteEvents_Input xmlns="urn:crmondemand/ws/integrationevent/">
         <DateTime>08/09/2011 10:40:53</DateTime>
         <LastEventId>20110809152116757_QNMHRZ780-I5RT8_Contact_Contact_ADSA-96CRZK_1_ADSA-96CSA5.xml</LastEventId>
         <QueueName>Default Queue</QueueName>
      </IntegrationEventWS_DeleteEvents_Input>
   </soap:Body>
</soap:Envelope>

Sample Soap Response

The following SOAP response contains the deleted event:

<?xml version="1.0" encoding="utf-8"?>
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://
www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
   <SOAP-ENV:Body>
      <ns:IntegrationEventWS_DeleteEvents_Output xmlns:ns="urn:crmondemand/ws/integrationevent/">
         <ns:LastEventId>20110809152116757_QNMHRZ780-I5RT8_Contact_Contact_ADSA-96CRZK_1_ADSA-96CSA5.xml</ns:LastEventId>
         <ns:QueueName>Default Queue</ns:QueueName>
      </ns:IntegrationEventWS_DeleteEvents_Output>
   </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

ExportWebServiceCreateExportRequest

Creates a data export request.

Usage

Use the ExportWebServiceCreateExportRequest method to create an export request. The ADMIN_EXPORT privilege is required.

For more information about export requests, see Oracle CRM On Demand Online Help.

Arguments

The following table describes the arguments taken by the ExportWebServiceCreateExportRequest method.

Table Arguments Taken by the ExportWebServiceCreateExportRequest Method

Name	Description	Required	Default	I/O
ListOfRecordType	The record types to be exported.	Yes	Not applicable	Input
TimeZone	The time zone.	Yes	Not applicable	Input
ScanExportZipFileForViruses	Whether the zip file for the export request is scanned for viruses (true) or not scanned (false).	No	Not applicable	Input
DateTimeFormat	The date and time format used in the CSV file, for example: USA - MM/DD/YYYY hh:mm:ss PM.	Yes	Not applicable	Input
ExportDataModifiedAfter	Specifies that data modified on or after the given date is exported.	No	Not applicable	Input
ExportDataModifiedBefore	Specifies that data modified before the given date is exported.	No	Not applicable	Input
EnableMailNotificationflag	Whether email notifications are enabled (true) or disabled (false).	No	Not applicable	Input
IncludeWebLinkURL	Whether URLs are included for Weblinks in the export request (true) or excluded (false).	No	Not applicable	Input
Delimiter	The type of CSV delimiter used in the file: Comma (,) or Semi-Colon (;).	Yes	Not applicable	Input
RequestId	The export request ID.	Not applicable	Not applicable	Output

Return Value of the Call

The export request ID.

Sample SOAP Requests and Responses

This topic contains sample SOAP requests that invoke ExportWebServiceCreateExportRequest.

Sample SOAP Request 1 - ExportWebServiceCreateExportRequest: Request for a Comma-delimited Export for Multiple Record Types

The following SOAP sample invokes ExportWebServiceCreateExportRequest to request an export of account and contact records. By not specifying a value for <Delimiter>, comma-delimited export files are generated.

<?xml version="1.0" encoding="utf-8" standalone="no"?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/
XMLSchema-instance" xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-
secext-1.0.xsd" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
   <soap:Header>
      <wsse:Security>
         <wsse:UsernameToken>
            <wsse:Username>%%%USERNAME%%%</wsse:Username>
            <wsse:Password Type="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-username-token-profile-1.0#PasswordText">%%%PASSWORD%%%</wsse:Password>
         </wsse:UsernameToken>
      </wsse:Security>
   </soap:Header>
   <soap:Body>
      <ExportWebService_ExportWebServiceCreateExportRequest_Input xmlns="urn:crmondemand/ws/exportwebservice/">
         <TimeZone>(GMT-08:00) Pacific Time (US &amp; Canada); Tijuana</TimeZone>
         <ScanExportZipFileForViruses>false</ScanExportZipFileForViruses>
         <ListOfRecordType>
            <RecordType>
               <Name>Contact</Name>
            </RecordType>
            <RecordType>
               <Name>Account</Name>
            </RecordType>
         </ListOfRecordType>
         <EnableMailNotificationflag>false</EnableMailNotificationflag>
         <IncludeWebLinkURL>false</IncludeWebLinkURL>
         <DateTimeFormat>USA - MM/DD/YYYY hh:mm:ss PM</DateTimeFormat>
         <Delimiter></Delimiter>
      </ExportWebService_ExportWebServiceCreateExportRequest_Input>
   </soap:Body>
</soap:Envelope>

Sample SOAP Request 2 - ExportWebServiceCreateExportRequest: Request for a Semicolon-delimited Export of Records Modified Between Two Dates

The following SOAP sample invokes ExportWebServiceCreateExportRequest to request a semicolon-delimited export of contact records modified between 12/06/2011 and 12/07/2011 (6th and 7th December 2011).

<?xml version="1.0" encoding="utf-8" standalone="no"?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/
XMLSchema-instance" xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-
secext-1.0.xsd" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
   <soap:Header>
      <wsse:Security>
         <wsse:UsernameToken>
            <wsse:Username>%%%USERNAME%%%</wsse:Username>
            <wsse:Password Type="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-username-token-profile-1.0#PasswordText">%%%PASSWORD%%%</wsse:Password>
         </wsse:UsernameToken>
      </wsse:Security>
   </soap:Header>
   <soap:Body>
      <ExportWebService_ExportWebServiceCreateExportRequest_Input xmlns="urn:crmondemand/ws/exportwebservice/">
         <ExportDataModifiedBefore>12/07/2011</ExportDataModifiedBefore>
         <TimeZone>(GMT-08:00) Pacific Time (US &amp; Canada); Tijuana</TimeZone>
         <ScanExportZipFileForViruses>false</ScanExportZipFileForViruses>
         <ListOfRecordType>
            <RecordType>
               <Name>Contact</Name>
            </RecordType>
         </ListOfRecordType>
         <EnableMailNotificationflag>false</EnableMailNotificationflag>
         <IncludeWebLinkURL>false</IncludeWebLinkURL>
         <DateTimeFormat>USA - MM/DD/YYYY hh:mm:ss PM</DateTimeFormat>
         <ExportDataModifiedAfter>12/06/2011</ExportDataModifiedAfter>
         <Delimiter>Semi-Colon</Delimiter>
      </ExportWebService_ExportWebServiceCreateExportRequest_Input>
   </soap:Body>
</soap:Envelope>

Sample SOAP Responses

The response is the same for both of the sample SOAP requests:

<?xml version="1.0" encoding="utf-8"?>
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://
www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
   <SOAP-ENV:Body>
      <ns:ExportWebService_ExportWebServiceCreateExportRequest_Output xmlns:ns="urn:crmondemand/ws/exportwebservice/">
         <ns:RequestId>1QA2-16438E</ns:RequestId>
      </ns:ExportWebService_ExportWebServiceCreateExportRequest_Output>
   </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

ExportWebServiceMonitorExportRequest

Retrieves the status and other details about an export request.

Usage

Use the ExportWebServiceMonitorExportRequest method to retrieve the status and other details for an export request. For successfully completed export requests, the <ListOfAttachmentInfo> argument contains the set of ID values for the files generated for the request. Export requests that are in progress do not return any values for <ListOfAttachmentInfo>.

Note: The actual attachment file is not retrieved using this method but must be retrieved using the ExportWebServiceRetrieveExportAttachment method.

The <AttachmentInfo> child element of <ListOfAttachmentInfo> contains the following for each attachment:

• FileId. The file ID.

• FileName. The filename of the attachment.

• FileExt. The file extension.

• FileSize. The file size in KB. The maximum file size for an attachment is 20 MB.

Arguments

The following table describes the arguments taken by the ExportWebServiceMonitorExportRequest method.

Table Arguments Taken by the ExportWebServiceMonitorExportRequest Method

Name	Description	Required	Default	I/O
RequestId	The export request ID.	Yes	Not applicable	Input
CompletionDateTime	The date and time of completion of the request.	No	Not applicable	Output
NumberProcessed	The number of records processed by the request.	No	Not applicable	Output
Status	The status of this Web service call.	Not applicable	Not applicable	Output
ErrorMessage	Any error message from this Web service call, or a message indicating success.	Not applicable	Not applicable	Output
ListOfAttachmentInfo	The attachment information.	Not applicable	Not applicable	Output

Return Value of the Call

The output arguments.

Sample SOAP Request - ExportWebServiceMonitorExportRequest

The following SOAP sample invokes ExportWebServiceMonitorExportRequest to retrieve the status and other details of an export request identified by the request ID.

<?xml version="1.0" encoding="utf-8" standalone="no"?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/
XMLSchema-instance" xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-
secext-1.0.xsd" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
   <soap:Header>
      <wsse:Security>
         <wsse:UsernameToken>
            <wsse:Username>%%%USERNAME%%%</wsse:Username>
            <wsse:Password Type="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-username-token-profile-1.0#PasswordText">%%%PASSWORD%%%</wsse:Password>
         </wsse:UsernameToken>
      </wsse:Security>
   </soap:Header>
   <soap:Body>
      <ExportWebService_ExportWebServiceMonitorExportRequest_Input xmlns="urn:crmondemand/ws/exportwebservice/">
         <RequestId>1QA2-16438E</RequestId>
      </ExportWebService_ExportWebServiceMonitorExportRequest_Input>
   </soap:Body>
</soap:Envelope>

Sample SOAP Response

The following SOAP response contains the status and other details of the export request:

<?xml version="1.0" encoding="utf-8"?>
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://
www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
   <SOAP-ENV:Body>
      <ns:ExportWebService_ExportWebServiceMonitorExportRequest_Output xmlns:ns="urn:crmondemand/ws/exportwebservice/">
         <ns:Status>Completed</ns:Status>
         <ns:CompletionDateTime>12/07/2011 08:48:15</ns:CompletionDateTime>
         <ns:NumberProcessed>1</ns:NumberProcessed>
         <ns:ErrorMessage>OK</ns:ErrorMessage>
         <ListOfAttachmentInfo xmlns="http://www.siebel.com/xml/ExportWSAttachmentInfo">
            <AttachmentInfo>
               <FileId>1QA2-166416</FileId>
               <FileName>OnDemandExport_20111207_1QA2-16438E_0001</FileName>
               <FileExt>zip</FileExt>
               <FileSize>3385</FileSize>
            </AttachmentInfo>
         </ListOfAttachmentInfo>
      </ns:ExportWebService_ExportWebServiceMonitorExportRequest_Output>
   </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

ExportWebServiceRetrieveExportAttachment

Retrieves the files generated by an export request.

Usage

Use the ExportWebServiceRetrieveExportAttachment method to retrieve an attachment for an export request by specifying the AttachmentId value of the attachment. You can retrieve the AttachmentId value by using the ExportWebServiceMonitorExportRequest method.

The maximum size of an attachment file generated through a Web services call is 20MB. It is possible to generate larger attachment files through the Oracle CRM On Demand UI, but you cannot retrieve such files using the ExportWebServiceRetrieveExportAttachment method; such files must be downloaded from the Export Request Queue page in Oracle CRM On Demand.

Note: Only one attachment can be retrieved at a time.

Arguments

The following table describes the arguments taken by the ExportWebServiceRetrieveExportAttachment method.

Table Arguments Taken by the ExportWebServiceRetrieveExportAttachment Method

Name	Description	Required	Default	I/O
RequestId	The export request ID.	Yes	Not applicable	Input
AttachmentId	The attachment ID.	Not applicable	Not applicable	Input
Attachment	The attachment retrieved in Base64 encoded format.	Not applicable	Not applicable	Output

Return Value of the Call

The base64-encoded file with the specified Id value is returned.

Sample SOAP Request - ExportWebServiceRetrieveExportAttachment

The following SOAP sample invokes ExportWebServiceRetrieveExportAttachment to retrieve the export files based on the export request ID and the attachment file ID:

<?xml version="1.0" encoding="utf-8" standalone="no"?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/
XMLSchema-instance" xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-
secext-1.0.xsd" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
   <soap:Header>
      <wsse:Security>
         <wsse:UsernameToken>
            <wsse:Username>%%%USERNAME%%%</wsse:Username>
            <wsse:Password Type="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-username-token-profile-1.0#PasswordText">%%%PASSWORD%%%</wsse:Password>
         </wsse:UsernameToken>
      </wsse:Security>
   </soap:Header>
   <soap:Body>
      <ExportWebService_ExportWebServiceRetrieveExportAttachment_Input xmlns="urn:crmondemand/ws/exportwebservice/">
         <RequestId>1QA2-16438E</RequestId>
         <AttachmentId>1QA2-166416</AttachmentId>
      </ExportWebService_ExportWebServiceRetrieveExportAttachment_Input>
   </soap:Body>
</soap:Envelope>

Sample SOAP Response

The following SOAP response contains the requested attachment:

<?xml version="1.0" encoding="utf-8"?>
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://
www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
   <SOAP-ENV:Body>
      <ns:ExportWebService_ExportWebServiceRetrieveExportAttachment_Output xmlns:ns="urn:crmondemand/ws/exportwebservice/">
         <ns:Attachment>UEsDBBQAAAAIAAhOhz/
CCm0jUAEAAHkCAAAmAHEARXhwb3J0U3VtbWFyeV8yMDExMTIwN18xUUEyLTE2NDM4RS50eHRTRFwApAAAAAAIAA6Py89jZGBpEGFgYFBh
gAAHIGZkAjNZFYCEApDNyArhiwKJr2aunmplcvrK8cnZIHVMDCkMLGBpCYb/
...
CCm0jUAEAAHkCAAAmABEAAAAAAAEAIAC2gQAAAABFeHBvcnRTdW1tYXJ5XzIwMTExMjA3XzFRQTItMTY0MzhFLnR4dFNEBACkAAAAVVQF
AAfPmN9OUEsBAhcLFAAAAAgACE6HP1i0K0QbCwAAkVMAAB0AEQAAAAAAAQAgALaBBQIAAENvbnRhY3RzXzFRQTItMTY0MzhFXzAwMDEuY
3N2U0QEAKQAAABVVAUAB8+Y305QSwUGAAAAAAIAAgDBAAAAzA0AAAAA</ns:Attachment>
      </ns:ExportWebService_ExportWebServiceRetrieveExportAttachment_Output>
   </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

GetEvents

Returns events from an integration event queue.

Objects Supported

GetEvents is supported for all objects that use Web Services v2.0 Schema and the following objects that use Web Services v1.0 Schema:

Account, Account Competitor, Account Contact, Account Contact Role, Account Note, Account Team, Activity, Activity Attachment, Asset, Call PromItemDrop, Call SampleDropped, Campaign, Contact, Contact Campaign, Contact Interests, Contact Note, Contact Team, Custom Object 01 - 03, Custom Object 01 - 03 Team, Dealer, Event Household, Household Contact, HouseholdTeam, Lead, Lead Team, Opportunity, Opportunity Competitor, Opportunity Contact Role, Opportunity Note, Opportunity Partner, Opportunity Team, Portfolio, Portfolio Owner, PortfolioTeam, Product, ProductCategory, Program, Program Partner, Service Request, Service Request Note, Service Request Team, Solution, Territory, Vehicle.

Usage

You use the GetEvents method of the Integration Event Web service to return events from an integration event queue. Integration events are actions that are triggered based on meeting certain workflow criteria. An integration event stores information about data that has changed:

• User key information about the changed record, for example: objectID, externalsystemID

• Audit information, for example, created date, created by, modified date, modified by

For integration events resulting from merge operations, the objectId and externalsystemId of both the primary and duplicate records are returned:

• DeletedRecordExternalSystemId

• DeletedRecordId

• MergedRecordExternalSystemId

• MergedRecordId

When company administrators create an Integration Event action on a workflow rule, they can specify the schema version to be used for integration events. The default schema version is Web Services v2.0 schema, but for objects that support both Web Services v1.0 and Web Services v2.0 Schema, the company administrator can select either schema version.

Integration events are stored in one or more company queues on the hosted environment. The maximum number of events in the queues is set by Customer Care. Contact Customer Care to request support for the Integration Event Web Service and to specify the maximum total size of the integration queues you require.

In the Integration Event Queue Settings page in the UI, the Picklist Format field determines whether language-independent values or language-dependent values (in the user’s language) for picklists are written to an integration event queue.

For more information about integration events and setting up workflow criteria, see Oracle CRM On Demand Online Help.

If the EventCount argument is not supplied, all events are returned.

The QueueName argument, if specified, must match the name of a queue defined for a company within Oracle CRM On Demand. The QueueName value is the localized display name value for the user. If the supplied name is not valid, an error message is returned.

If QueueName is not specified, the value is empty, or if the value is Default Queue, events are returned from the default queue.

When there is a pending request to a queue, another call to the same queue cannot be invoked until the previous request completes. However, another call to a different queue can be invoked before the previous request completes.

You can return events for all supported record types, or a subset of record types, depending on how you prepare the WSDL and Schema files associated with the Integration Event service, see Preparing the Integration Event WSDL File and Schema Files.

In some cases the names of objects in the list of events returned differ from the name of the object used in the UI of Oracle CRM On Demand, as shown in Mapping of Display Names to Service API Object Names.

Time Zone Setting for Integration Events

On the Integration Event Queue Settings page in the UI your company administrator can specify settings for the default queue. The Time Zone picklist determines how the values of date and time fields (for example, ModifiedDate, CreatedDate) are recorded in integration events.

You can also use the IntegrationEventQueueUpsert method to specify values for the Time Zone field, and the values you can specify are UTC, UTC Format, and User Time Zone (the default value) as explained in IntegrationEventQueueUpsert.

Arguments

The following table describes the arguments taken by the GetEvents method.

Table Arguments Taken by the Get Events Method

Name	Description	Required	Default	I/O
EventCount	The maximum number of events to be returned.	No	Not applicable	Input
QueueName	The integration event queue name.	No	Default queue	Input/Output
ListOfEvent	A list of events	Not applicable	Not applicable	Output
LastEventID	An event ID	Not applicable	Not applicable	Output

Return Value of the Call

A list of the events returned from the integration event queue. Also, the ID of the last event returned.

The QueueName value is returned, if it is specified in the GetEvents request.

For each event in the list of events, there are the following attributes:

• name. The name of the associated Workflow.

• object. The record type.

• operation. The operation performed. The attribute values can be:

  • insert - for items inserted

  • update - for items updated

  • merge - for items merged

  • purge - for items that have been purged from the Deleted Items area

  • delete - for items that have been deleted and are still in the Deleted Items area

  • restore - for items that have been deleted and then restored

  • associate - for child items that have been associated with a parent record type

  • dissociate - for child items that have been dissociated from a parent record type

  Note: Only the Activity, Account, Contact, and Opportunity objects support the associate and dissociate operations. The integration events generated for these objects vary depending on whether the request is made through a Web service request or the UI. For more information, about these differences in integration events, see the information about workflow rules in Oracle CRM On Demand Online Help.

Sample SOAP Request and Responses

This topic contains sample SOAP requests that invoke GetEvents.

Sample SOAP Request 1 - GetEvents with No Arguments

In the following SOAP request, no arguments are passed in (there are no required arguments for GetEvents), all the events from the default queue are retrieved:

<?xml version="1.0" encoding="utf-8" standalone="no"?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/
XMLSchema-instance" xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-
secext-1.0.xsd" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
   <soap:Header>
      <wsse:Security>
         <wsse:UsernameToken>
            <wsse:Username>%%%USERNAME%%%</wsse:Username>
            <wsse:Password Type="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-username-token-profile-1.0#PasswordText">%%%PASSWORD%%%</wsse:Password>
         </wsse:UsernameToken>
      </wsse:Security>
   </soap:Header>
   <soap:Body>
      <IntegrationEventWS_GetEvents_Input xmlns="urn:crmondemand/ws/integrationevent/"></
IntegrationEventWS_GetEvents_Input>
   </soap:Body>
</soap:Envelope>

Sample SOAP Response 1

The following shows the response for sample request 1. The events from the default queue are returned.

<?xml version="1.0" encoding="utf-8"?>
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://
www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
   <SOAP-ENV:Body>
      <ns:IntegrationEventWS_GetEvents_Output xmlns:ns="urn:crmondemand/ws/integrationevent/">
         <ListOfEvent xmlns="urn:/crmondemand/xml/integrationevent">
            <Event object="Contact" name="cContact Update" operation="update">
               <SiebelMessage>
                  <ListOfContact xmlns="urn:/crmondemand/xml/contact">
                     <Contact>
                        <ContactId>ADSA-96CRZK</ContactId>
                        <ModId>1</ModId>
                        <CreatedDate>08/09/2011 10:17:48</CreatedDate>
                        <ExternalSystemId></ExternalSystemId>
                        <ContactFirstName>Testing</ContactFirstName>
                        <IntegrationId>ADSA-96CRZK</IntegrationId>
                        <ContactLastName>U2</ContactLastName>
                        <ModifiedById>HRZ780-I5RUE</ModifiedById>
                        <ModifiedDate>08/09/2011 10:21:16</ModifiedDate>
                        <AlternateAddressId>ADSA-6CRZM</AlternateAddressId>
                        <CreatedById>HRZ780-I5RUE</CreatedById>
                     </Contact>
                  </ListOfContact>
               </SiebelMessage>
            </Event>
            <Event object="Contact" name="cContact - Send Welcome Package" operation="insert">
               <SiebelMessage>
                  <ListOfContact xmlns="urn:/crmondemand/xml/contact">
                     <Contact>
                        <ContactId>ADSA-96D7AO</ContactId>
                        <ModId>0</ModId>
                        <AccountId>No Match Row Id</AccountId>
                        <CreatedDate>08/09/2011 10:40:52</CreatedDate>
                        <ExternalSystemId></ExternalSystemId>
                        <ContactFirstName>Testing2</ContactFirstName>
                        <IntegrationId>ADSA-96D7AO</IntegrationId>
                        <ContactLastName>U1</ContactLastName>
                        <ModifiedById>HRZ780-I5RUE</ModifiedById>
                        <ModifiedDate>08/09/2011 10:40:53</ModifiedDate>
                        <AlternateAddressId>ADSA-96D7AQ</AlternateAddressId>
                        <CreatedById>HRZ780-I5RUE</CreatedById>
                     </Contact>
                  </ListOfContact>
               </SiebelMessage>
            </Event>
            <Event object="Contact" name="cContact Update" operation="update">
               <SiebelMessage>
                  <ListOfContact xmlns="urn:/crmondemand/xml/contact">
                     <Contact>
                        <ContactId>ADSA-96D7EA</ContactId>
                        <ModId>2</ModId>
                        <CreatedDate>08/09/2011 10:45:39</CreatedDate>
                        <ExternalSystemId></ExternalSystemId>
                        <ContactFirstName>C</ContactFirstName>
                        <IntegrationId>ADSA-96D7EA</IntegrationId>
                        <ContactLastName>C8</ContactLastName>
                        <ModifiedById>HRZ780-I5RUE</ModifiedById>
                        <ModifiedDate>08/09/2011 10:57:52</ModifiedDate>
                        <AlternateAddressId>ADSA-96D7EC</AlternateAddressId>
                        <CreatedById>HRZ780-I5RUE</CreatedById>
                     </Contact>
                  </ListOfContact>
               </SiebelMessage>
            </Event>
            <Event object="Account" name="Accounts Create" operation="insert">
               <SiebelMessage>
                  <ListOfAccount xmlns="urn:/crmondemand/xml/account">
                     <Account>
                        <AccountId>ADSA-96DJL4</AccountId>
                        <ModId>0</ModId>
                        <CreatedDate>08/09/2011 11:04:50</CreatedDate>
                        <CurrencyCode>USD</CurrencyCode>
                        <ExternalSystemId></ExternalSystemId>
                        <IntegrationId>ADSA-96DJL4</IntegrationId>
                        <Location></Location>
                        <ModifiedById>HRZ780-I5RUE</ModifiedById>
                        <ModifiedDate>08/09/2011 11:04:51</ModifiedDate>
                        <AccountName>A1</AccountName>
                        <NumberEmployees>1000</NumberEmployees>
                        <PrimaryBillToAddressId>ADSA-96DJL6</PrimaryBillToAddressId>
                        <PrimaryShipToAddressId>ADSA-96DJL8</PrimaryShipToAddressId>
                        <CreatedById>HRZ780-I5RUE</CreatedById>
                     </Account>
                  </ListOfAccount>
               </SiebelMessage>
            </Event>
         </ListOfEvent>
         <ns:LastEventId>20110809160454038_QNMHRZ780-I5RT8_Account_Account_ADSA-96DJL4_0_ADSA-
96DCMZ.xml</ns:LastEventId>
      </ns:IntegrationEventWS_GetEvents_Output>
   </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

Sample SOAP Request 2 - GetEvents with EventCount and QueueName

The following SOAP request retrieves one event from the queue High Priority Queue specified by using the <EventCount> and <QueueName> arguments.

<?xml version="1.0" encoding="utf-8" standalone="no"?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/
XMLSchema-instance" xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-
secext-1.0.xsd" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
   <soap:Header>
      <wsse:Security>
         <wsse:UsernameToken>
            <wsse:Username>%%%USERNAME%%%</wsse:Username>
            <wsse:Password Type="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-username-token-profile-1.0#PasswordText">%%%PASSWORD%%%</wsse:Password>
         </wsse:UsernameToken>
      </wsse:Security>
   </soap:Header>
   <soap:Body>
      <IntegrationEventWS_GetEvents_Input xmlns="urn:crmondemand/ws/integrationevent/">
         <QueueName>High Priority Queue</QueueName>
         <EventCount>1</EventCount>
      </IntegrationEventWS_GetEvents_Input>
   </soap:Body>
</soap:Envelope>

Sample SOAP Response 2

The following shows the response for sample SOAP request 2. The events from the named queue are returned.

<?xml version="1.0" encoding="utf-8"?>
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://
www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
   <SOAP-ENV:Body>
      <ns:IntegrationEventWS_GetEvents_Output xmlns:ns="urn:crmondemand/ws/integrationevent/">
         <ListOfEvent xmlns="urn:/crmondemand/xml/integrationevent">
            <Event object="Contact" name="cContact Update" operation="update">
               <SiebelMessage>
                  <ListOfContact xmlns="urn:/crmondemand/xml/contact">
                     <Contact>
                        <ContactId>ADSA-96CRZK</ContactId>
                        <ModId>1</ModId>
                        <CreatedDate>08/09/2011 10:17:48</CreatedDate>
                        <ExternalSystemId></ExternalSystemId>
                        <ContactFirstName>Testing</ContactFirstName>
                        <IntegrationId>ADSA-96CRZK</IntegrationId>
                        <ContactLastName>U2</ContactLastName>
                        <ModifiedById>HRZ780-I5RUE</ModifiedById>
                        <ModifiedDate>08/09/2011 10:21:16</ModifiedDate>
                        <AlternateAddressId>ADSA-96CRZM</AlternateAddressId>
                        <CreatedById>HRZ780-I5RUE</CreatedById>
                     </Contact>
                  </ListOfContact>
               </SiebelMessage>
            </Event>
         </ListOfEvent>
         <ns:LastEventId>20110809152116757_QNMHRZ780-I5RT8_Contact_Contact_ADSA-96CRZK_1_ADSA-
96CSA5.xml</ns:LastEventId>
         <ns:QueueName>Sample Queue</ns:QueueName>
      </ns:IntegrationEventWS_GetEvents_Output>
   </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

Preparing the Integration Event WSDL File and Schema Files

You can use the methods of the Integration Events service to track changes for the supported record types. You must download the integrationevent.wsdl file and the XSD Schema file for each record type that you require to track. You can download XSD files for all objects for the Web Services v1.0 API and for the Web Services v2.0 API. The integration event WSDL file imports the XSD files for each record type.

In addition, to get integration events generated for merge operations, you must download a Merge schema file and integrate this and the integration event WSDL file with your application. Existing customers must download the latest integrationevent.wsdl file, if they wish to use the Merge schema file.

Note: The Merge schema file is only applicable to integration events processing and cannot be used for other purposes.

The integrationevent.wsdl file is dynamically generated based on which objects have an active workflow rule with an integration event action configured.

For each object with an integration event action configured, a child element of <SiebelMessage> is added to the WSDL files, for example, <ListOfAccount>.

For child objects, an element is added for the parent object, for example, an entry for the Account parent object is added for the Account Team child. For child objects with multiple parents, an element is added for each possibe parent, for example, Account, Contact, and Opportunity parent entries would be added for a Revenue child.

Also, for each object, one or more <import> elements are added to the WSDL file with attributes for the namespace and schema location of an XSD file. The attribute values depend on whether Web Services v1.0 or Web Services v2.0 Schema have been selected for the integration events for the object. The following is an example of an <import> element for an object with an integration event for which the Web Services v1.0 Schema is selected:

<xsd:import namespace="urn:/crmondemand/xml/account" schemaLocation="Account.xsd" /> 

The following is an example of an <import> element for an object with an integration event for which the Web Services v2.0 Schema is selected:

<xsd:import namespace="urn:/crmondemand/xml/Account/Data" schemaLocation="Account.xsd" />

For more information about specifying the schema version when creating integration event actions, see Oracle CRM On Demand Online Help.

To prepare the WSDL

1. Go to the Web Services Administration page in the Oracle CRM On Demand application.

2. Download the Integration Events WSDL.

3. Download the Generic Schema files for objects for which you wish to generate integration events and copy these to the folder where you downloaded the WSDL file.

4. If you have created custom fields or renamed fields for an object, download the Custom XSD file for the object.

5. If you require to access events resulting from merge operations, download the generic schema file for the Merge Service API.

6. In the integrationevent.wsdl file, remove references to any Schema files for objects you will not be using.

7. Add the integrationevent.wsdl file to your development environment.

Note: You must repeat steps 3 through 7 each time a new custom field is added that will be tracked through integration events, or when you begin tracking a new object type. Otherwise, the client application cannot process events containing these newly added fields or objects.

GetLists

Gets the set of lists that the current user has access to for a specified object.

Usage

You use the GetLists method to query the details of the lists for an object.

The ObjectName argument specifies the object to be queried. The names of system lists and public and private lists are returned. The set of list names is equivalent to the set of list names visible to the user in the Manage Lists page UI.

ListQueryPage is supported for all objects that support list management.

The list names returned can be used in a QueryPage operation to retrieve the set of records matching the list filter criteria.

Arguments

The following table describes the arguments taken by the GetLists method:

Table Arguments Taken by the Get Lists Method

Name	Description	Required	Default	I/O
ObjectName	The name of the object.	Yes	Not applicable	Input
ListOfLists	The list of lists returned for the object.	Not applicable	Not applicable	Output

Return Value of the Call

The following information is returned for each list:

• Name. The name of the list.

• ListType. Whether the list is a system list, public list, or a private list created by the current user.

Sample SOAP Request - GetLists

The following SOAP request retrieves the set of lists visible to the authenticated user for the account record type as specified in the <ObjectName> argument:

<?xml version="1.0" encoding="utf-8" standalone="no"?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/
XMLSchema-instance" xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-
secext-1.0.xsd" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
   <soap:Header>
      <wsse:Security>
         <wsse:UsernameToken>
            <wsse:Username>%%%USERNAME%%%</wsse:Username>
            <wsse:Password Type="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-username-token-profile-1.0#PasswordText">%%%PASSWORD%%%</wsse:Password>
         </wsse:UsernameToken>
      </wsse:Security>
   </soap:Header>
   <soap:Body>
      <ListsWS_GetLists_Input xmlns="urn:crmondemand/ws/lists/">
         <ObjectName>Account</ObjectName>
      </ListsWS_GetLists_Input>
   </soap:Body>
</soap:Envelope>

Sample SOAP Response

The following response contains the lists for the account object:

<?xml version="1.0" encoding="utf-8"?>
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://
www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
   <SOAP-ENV:Body>
      <ns:ListsWS_GetLists_Output xmlns:ns="urn:crmondemand/ws/lists/">
         <ListofLists xmlns="urn:/crmondemand/xml/lists">
            <List>
               <Name>All Account Competitor Accounts</Name>
               <ListType>System</ListType>
            </List>
            <List>
               <Name>All Account Partner Accounts</Name>
               <ListType>System</ListType>
            </List>
            <List>
               <Name>All Accounts</Name>
               <ListType>System</ListType>
            </List>
            <List>
               <Name>All Customer Accounts</Name>
               <ListType>System</ListType>
            </List>
            <List>
               <Name>All Prospect Accounts</Name>
               <ListType>System</ListType>
            </List>
            <List>
               <Name>All Referenceable Accounts</Name>
               <ListType>System</ListType>
            </List>
            <List>
               <Name>All Top Accounts</Name>
               <ListType>System</ListType>
            </List>
            <List>
               <Name>My Accounts</Name>
               <ListType>System</ListType>
            </List>
            <List>
               <Name>My Recently Created Accounts</Name>
               <ListType>System</ListType>
            </List>
            <List>
               <Name>My Recently Modified Accounts</Name>
               <ListType>System</ListType>
            </List>
            <List>
               <Name>Recently Created Accounts</Name>
               <ListType>System</ListType>
            </List>
            <List>
               <Name>Recently Modified Accounts</Name>
               <ListType>System</ListType>
            </List>
         </ListofLists>
      </ns:ListsWS_GetLists_Output>
   </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

GetMapping

Returns the display names and XML tags of the fields of a record type or one of its child components.

Objects Supported

GetMapping is supported for all objects accessible through Web Services V1.0 and Web Services 2.0 and all of their child components.

Usage

You use the GetMapping method to return the mapping between the display names of all the fields in a particular record type and the XML tags for each field.

If the record type is supported for Web Services v1.0, then the mapping between the display name of the fields and the XML tag name for Web Services v1.0 is returned. This is the case even if the record type is supported for Web Services v2.0 as well.

If the record type is only supported for Web Services v2.0, then the mapping between the display name and the XML tag name for Web Services v2.0 is returned.

GetMapping returns only the mapping for fields that are exposed for both the UI and Web services. If a field is not exposed in the UI, then it is not returned by GetMapping for the record type.

In some cases, the names of objects used in the ObjectName argument differ from the name of the object used in the UI of Oracle CRM On Demand, as shown in Mapping of Display Names.

The GetMapping method works with all Custom Objects. However, you must use a different naming convention for Custom Objects 1-3, compared to Custom Object 4 and higher, where there are no spaces in the object name. SOAP requests must use the following naming convention for object names:

• Custom Object 1-3. Custom Object 1, Custom Object 2, Custom Object 3

• Custom Object 4 and higher. CustomObject4...CustomObject14, and so on

For some fields, the DisplayName returned has the value hidden. These fields are available in the WSDL file for the object, but are not available in the Oracle CRM On Demand UI. Examples of fields for which the value hidden is returned include the LanguageCode, LocaleCode, RoleId, and TimeZoneId fields of the User object.

Arguments

The following table describes the arguments taken by the GetMapping method.

Table Arguments Taken by the Get Mapping Method

Name	Description	Required	Default	I/O
ObjectName	The name of the record type for which you wish to return a list of mappings.	Yes	Not applicable	Input/Output

Return Value of the Call

A list of the display names for fields and their associated XML mappings:

• LastUpdated. The date the field was last updated.

• DisplayName. The display name of the field, in the user’s language. For some fields not available in the UI, the value hidden is returned.

• ElementName. The XML element name for the field.

• DataType. The field type of the field, for example, Check box, Picklist, and so on.

Sample SOAP Request - GetMapping

The following SOAP request retrieves the display names and XML element names of the fields of the book record type as specified in the <ObjectName> argument:

<?xml version="1.0" encoding="utf-8" standalone="no"?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/
XMLSchema-instance" xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-
secext-1.0.xsd" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
   <soap:Header>
      <wsse:Security>
         <wsse:UsernameToken>
            <wsse:Username>%%%USERNAME%%%</wsse:Username>
            <wsse:Password Type="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-username-token-profile-1.0#PasswordText">%%%PASSWORD%%%</wsse:Password>
         </wsse:UsernameToken>
      </wsse:Security>
   </soap:Header>
   <soap:Body>
      <MappingWS_GetMapping_Input xmlns="urn:crmondemand/ws/mapping/">
         <ObjectName>Book</ObjectName>
      </MappingWS_GetMapping_Input>
   </soap:Body>
</soap:Envelope>

Sample SOAP Response

The following response contains the mappings for a number of fields for the book object:

<?xml version="1.0" encoding="utf-8"?>
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://
www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
   <SOAP-ENV:Body>
      <ns:MappingWS_GetMapping_Output xmlns:ns="urn:crmondemand/ws/mapping/">
         <ns:ObjectName>Book</ns:ObjectName>
         <ListOfField xmlns="urn:/crmondemand/xml/mappingservice">
            <Field>
               <DisplayName>Can Contain Data</DisplayName>
               <ElementName>CanContainDataFlag</ElementName>
               <DataType>Checkbox</DataType>
            </Field>
            <Field>
               <DisplayName>Id</DisplayName>
               <ElementName>BookId</ElementName>
               <DataType>ID</DataType>
            </Field>
            <Field>
               <DisplayName>Parent Book</DisplayName>
               <ElementName>ParentBookName</ElementName>
               <DataType>Picklist</DataType>
            </Field>
            <Field>
               <DisplayName>Created</DisplayName>
               <ElementName>CreatedBy</ElementName>
               <DataType>Text (Long)</DataType>
            </Field>
            <Field>
               <DisplayName>Book Type</DisplayName>
               <ElementName>BookType</ElementName>
               <DataType>Picklist</DataType>
            </Field>
            <Field>
               <DisplayName>Modified: Date</DisplayName>
               <ElementName>ModifiedDate</ElementName>
               <DataType>Date/Time</DataType>
            </Field>
            <Field>
               <DisplayName>Created: Date</DisplayName>
               <ElementName>CreatedDate</ElementName>
               <DataType>Date/Time</DataType>
            </Field>
            <Field>
               <DisplayName>Description</DisplayName>
               <ElementName>Description</ElementName>
               <DataType>Text (Long)</DataType>
            </Field>
            <Field>
               <DisplayName>Book Name</DisplayName>
               <ElementName>BookName</ElementName>
               <DataType>Text (Short)</DataType>
            </Field>
         </ListOfField>
      </ns:MappingWS_GetMapping_Output>
   </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

GetPicklistValues

Gets picklist values from Oracle CRM On Demand.

Objects Supported

GetPicklistValues is supported for all Web Services v1.0 and v2.0 accessible parent-level objects.

Usage

You use the GetPicklistValues method to enable external applications to present lists of values to users, typically in a language-dependent manner. The method can get lists of possible values for both cascading and regular picklist fields but cannot get the lists of possible values for read-only picklist fields.

If the record type is supported for Web Services v1.0, then the picklists returned are those applicable for Web Services v1.0. This is the case even if the record type is supported for Web Services v2.0 as well. If a picklist is not exposed for Web Services v1.0, then the picklist cannot be returned using GetPicklistValues, even if the picklist is exposed for Web Services v2.0.

If the record type is supported only for Web Services v2.0, then the picklists returned are those applicable for Web Services v2.0.

Because On Demand Web Services is language-independent, it is the client application’s responsibility to convert code from the language-independent code (LIC) used by Oracle CRM On Demand to language-dependent values (LDVs) typically used by the external presentation layer.

The returned list of values corresponds to the organization to which the current user belongs (that is, the user whose credentials have been passed during the log-in call).

The value of the Disabled input argument determines whether disabled picklist values of the specified picklist are returned as follows:

• N. The response includes only the active picklist values.

• Y. The response includes only the disabled picklist values.

• No value or not included in the request. The response includes all picklist values, including disabled values.

Cascading picklists restrict the values of one picklist, the related picklist, based on the value selected in another picklist, the parent picklist. For example, a parent picklist might present a list of IT areas and drive the value of a related picklist called SubAreas. When the user selects, for example, the value Installation for Area, the SubAreas picklist is dynamically constrained to show only the picklist values that are associated with the Installation area, for example, Server Crash and No Admin Login.

If the provided picklist has a parent, only the values that have a parent are returned. When a picklist has a parent, the result set includes the parent and the child values and at the end includes an empty set that contains all values available for the requested picklist.

If a picklist is not cascading, the following elements are returned empty:

• ParentFieldName

• ParentDisplayValue

• ParentCode

If a "10/2004" namespace is used, the FieldName and ParentFieldName elements respectively accept and return the integration tag value for custom fields, otherwise, they accept and return the generic custom field tag names (that is, CustomPicklist1 and so on).

Arguments

The following table describes the arguments taken by the GetPicklistValues method.

Table Arguments Taken by the GetPicklistValues Method

Name	Description	Required	Default	I/O
RecordType	The record type; this is case insensitive	Yes	Not applicable	Input
FieldName	The name of the picklist field.	Yes	Not applicable	Input
LanguageCode	The code of the language in which language-dependent values are to be returned, for example, ENU, DEU, FRA, ESN, and so on. If the code is not specified, the default language for the current session’s user is used.	No	User’s Default Language	Input
Disabled	Whether disabled values of the specified picklist are returned.	No	Not applicable	Input
ListOfParentPicklistValue	A sequence of ParentPicklistValue elements.	Yes	Not applicable	Output

Return Value of the Call

A list of picklist values. For a cascading picklist, this includes the values for the related picklist that apply for particular values of the parent picklist. For a regular picklist, values for parent picklist are not included.

The ParentPicklistValue element contains the following child elements:

• Language. The language.

• ParentFieldName. The parent picklist field name as an integration tag.

• ParentDisplayValue. A display value translated into the specified language.

• ParentCode. A parent Language Independent Code (LIC).

• Disabled. Whether the picklist value is disabled (Y) or active (N).

• ListOfPickListValue. A sequence of PicklistValue elements containing the related picklist values that correspond to the parent picklist value.

The PicklistValue element contains the following child elements:

• DisplayValue. The display value translated into the specified language.

• Code. The Language Independent Code (LIC).

• Disabled. Whether the picklist value is disabled (Y) or active (N).

Sample SOAP Request - GetPicklist

The following SOAP request retrieves the picklist values in French for the Priority picklist of the account record type.

<?xml version="1.0" encoding="utf-8" standalone="no"?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/
XMLSchema-instance" xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-
secext-1.0.xsd" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
   <soap:Header>
      <wsse:Security>
         <wsse:UsernameToken>
            <wsse:Username>%%%USERNAME%%%</wsse:Username>
            <wsse:Password Type="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-username-token-profile-1.0#PasswordText">%%%PASSWORD%%%</wsse:Password>
         </wsse:UsernameToken>
      </wsse:Security>
   </soap:Header>
   <soap:Body>
      <PicklistWS_GetPicklistValues_Input xmlns="urn:crmondemand/ws/picklist/">
         <RecordType>Account</RecordType>
         <FieldName>Priority</FieldName>
         <LanguageCode>FRA</LanguageCode>
      </PicklistWS_GetPicklistValues_Input>
   </soap:Body>
</soap:Envelope>

Sample SOAP Response

The following response contains values for the Priority picklist of Account, including the French language display values:

<?xml version="1.0" encoding="utf-8"?>
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://
www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
   <SOAP-ENV:Body>
      <ns:PicklistWS_GetPicklistValues_Output xmlns:ns="urn:crmondemand/ws/picklist/">
         <ListOfParentPicklistValue xmlns="urn:/crmondemand/xml/picklist">
            <ParentPicklistValue>
               <Language>FRA</Language>
               <ParentFieldName></ParentFieldName>
               <ParentDisplayValue></ParentDisplayValue>
               <ParentCode></ParentCode>
               <Disabled></Disabled>
               <ListOfPicklistValue>
                  <PicklistValue>
                     <Code>Low</Code>
                     <DisplayValue>Faible</DisplayValue>
                     <Disabled>N</Disabled>
                  </PicklistValue>
                  <PicklistValue>
                     <Code>Medium</Code>
                     <DisplayValue>Moyen</DisplayValue>
                     <Disabled>N</Disabled>
                  </PicklistValue>
                  <PicklistValue>
                     <Code>High</Code>
                     <DisplayValue>Elevé</DisplayValue>
                     <Disabled>N</Disabled>
                  </PicklistValue>
               </ListOfPicklistValue>
            </ParentPicklistValue>
         </ListOfParentPicklistValue>
      </ns:PicklistWS_GetPicklistValues_Output>
   </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

GetServerTime

Returns the time from a server.

Usage

You use the GetServerTime method to get the time at the server involved in a Web services API session. The time returned is converted to the time for the locale of the user ID making the request.

Return Value of the Call

The current server time.

Sample SOAP Request - GetServerTime

The following SOAP request retrieves the server time. No arguments are required.

<?xml version="1.0" encoding="utf-8" standalone="no"?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/
XMLSchema-instance" xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-
secext-1.0.xsd" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
   <soap:Header>
      <wsse:Security>
         <wsse:UsernameToken>
            <wsse:Username>%%%USERNAME%%%</wsse:Username>
            <wsse:Password Type="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-username-token-profile-1.0#PasswordText">%%%PASSWORD%%%</wsse:Password>
         </wsse:UsernameToken>
      </wsse:Security>
   </soap:Header>
   <soap:Body>
      <TimeWS_GetServerTime_Input xmlns="urn:crmondemand/ws/time/"></TimeWS_GetServerTime_Input>
   </soap:Body>
</soap:Envelope>

Sample SOAP Response

The following response contains the time:

<?xml version="1.0" encoding="utf-8"?>
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://
www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
   <SOAP-ENV:Body>
      <ns:TimeWS_GetServerTime_Output xmlns:ns="urn:crmondemand/ws/time/">
         <ns:CurrentServerTime>08/05/2011 10:54:27</ns:CurrentServerTime>
         <ns:TimeZone>(GMT-06:00) Central Time (US &amp; Canada)</ns:TimeZone>
      </ns:TimeWS_GetServerTime_Output>
   </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

HistoryDelete

Deletes entries from the Recently Viewed records section in the Action bar.

Usage

You use the HistoryDelete method to delete records from the Recently Viewed records section in the Action bar in the Oracle CRM On Demand application.

For delete operations, the user keys are either of:

• <Id>

• <ObjectName> + <ObjectId>

Arguments

The following table describes the arguments taken by the HistoryDelete method.

Table Arguments Taken by the History Delete Method

Name	Description	Required	Default	I/O
ListOfHistoryItem	The list of records to be deleted (input), and after execution, the list of records deleted (output).	Yes	Not applicable	Input/Output

Return Value of the Call

The deleted records with their status key fields are returned.

Sample SOAP Request - HistoryDelete

The following SOAP request deletes a record with the <Id> value of 1QA2-34ISOM from the Recently Viewed list:

<?xml version="1.0" encoding="utf-8" standalone="no"?>
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" 
xmlns:his="urn:crmondemand/ws/history/" xmlns:data="urn:/crmondemand/xml/historyitem/Data">
   <soapenv:Header>
      <wsse:Security xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd">
         <wsse:UsernameToken xmlns:wsu="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd">
            <wsse:Username>%%%USERNAME%%%<</wsse:Username> 
            <wsse:Password Type="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-username-token-profile-1.0#PasswordText">%%%PASSWORD%%%</wsse:Password> 
         </wsse:UsernameToken>
      </wsse:Security>
   <soapenv:Header/>
   <soapenv:Body>
      <his:HistoryDelete_Input>
         <data:ListOfHistoryItem>
            <data:HistoryItem>
               <data:Id>1QA2-34ISOM</data:Id>
            </data:HistoryItem>
         </data:ListOfHistoryItem>
      </his:HistoryDelete_Input>
   </soapenv:Body>
</soapenv:Envelope>

Sample SOAP Response - HistoryDelete

The following SOAP response contains the deleted record with its status key fields:

<?xml version="1.0" encoding="utf-8" standalone="no"?>
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" 
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/
2001/XMLSchema">
   <SOAP-ENV:Body>
      <ns:HistoryDelete_Output xmlns:ns="urn:crmondemand/ws/history/">
         <ListOfHistoryItem xmlns="urn:/crmondemand/xml/historyitem/Data">
            <HistoryItem>
               <Id>1QA2-34ISOM</Id>
               <CreatedById>1-CZ010</CreatedById>
               <CreatedDate>2018-05-18T09:59:42Z</CreatedDate>
               <CreatedBy>Tara Treadlightly, 05/18/2018 05:59:42</CreatedBy>
               <ModifiedById>1-CZ010</ModifiedById>
               <ModifiedDate>2018-05-18T10:15:30Z</ModifiedDate>
               <ModifiedBy>Tara Treadlightly, 05/18/2018 06:15:30</ModifiedBy>
               <ModId>1</ModId>
            </HistoryItem>
         </ListOfHistoryItem>
      </ns:HistoryDelete_Output>
   </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

HistoryInsertOrUpdate

Inserts or updates entries in the Recently Viewed records section in the Action bar.

Usage

You use the HistoryInsertOrUpdate method to insert or update records in the Recently Viewed records section in the Action bar in the Oracle CRM On Demand application.

For upsert operations, the user keys are either of:

• <Id>

• <ObjectName> + <ObjectId>

The only field that can be updated is the <Order> field.

Arguments

The following table describes the arguments taken by the HistoryInsertOrUpdate method.

Table Arguments Taken by the HistoryInsertOrUpdate Method

Name	Description	Required	Default	I/O
ListOfHistoryItem	The list of records to be inserted or updated (input), and after execution, the list of records inserted or updated (output).	Yes	Not applicable	Input/Output

Return Value of the Call

The inserted or updated records with their status key fields are returned.

Sample SOAP Request - HistoryInsertOrUpdate

The following SOAP request updates an account record with the <objectId> value of 1QA2-VKKBZ record in the Recently Viewed list. The order of the record within the list is changed.

<?xml version="1.0" encoding="utf-8" standalone="no"?>
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" 
xmlns:his="urn:crmondemand/ws/history/" xmlns:data="urn:/crmondemand/xml/historyitem/Data">
   <soapenv:Header>
      <wsse:Security xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd">
         <wsse:UsernameToken xmlns:wsu="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd">
            <wsse:Username>%%%USERNAME%%%</wsse:Username>
            <wsse:Password Type="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-username-token-profile-1.0#PasswordText">%%%PASSWORD%%%</wsse:Password>
         </wsse:UsernameToken>
      </wsse:Security>
   </soapenv:Header>
   <soapenv:Body>
      <his:HistoryInsertOrUpdate_Input>
         <data:ListOfHistoryItem>
            <data:HistoryItem>
               <data:ObjectName>Account</ObjectName>
               <data:ObjectId>1QA2-VKKBZ</ObjectId>
               <data:Order>12</Order>
            </data:HistoryItem>
         </data:ListOfHistoryItem>
      </his:HistoryQueryPage_Input>
   </soapenv:Body>
</soapenv:Envelope>

Sample SOAP Response - HistoryInsertOrUpdate

The following SOAP response contains the updated record with its status key fields:

<?xml version="1.0" encoding="utf-8" standalone="no"?>
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" 
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/
2001/XMLSchema">
   <SOAP-ENV:Body>
      <ns:HistoryInsertOrUpdate_Output xmlns:ns="urn:crmondemand/ws/history/">
         <ListOfHistoryItem xmlns="urn:/crmondemand/xml/historyitem/Data">
            <HistoryItem>
               <Id>1QA2-34ISOM</Id>
               <CreatedById>1-CZ010</CreatedById>
               <CreatedDate>2018-05-18T09:59:42Z</CreatedDate>
               <CreatedBy>Tara Treadlightly, 05/18/2018 05:59:42</CreatedBy>
               <ModifiedById>1-CZ010</ModifiedById>
               <ModifiedDate>2018-05-18T10:15:30Z</ModifiedDate>
               <ModifiedBy>Tara Treadlightly, 05/18/2018 06:15:30</ModifiedBy>
               <ModId>1</ModId>
            </HistoryItem>
         </ListOfHistoryItem>
      </ns:HistoryInsertOrUpdate_Output>
   </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

HistoryQueryPage

Executes a query against the Recently Viewed records section in the Action bar, and returns a subset of the records that match the search criteria set by the method arguments.

Usage

You use the HistoryQueryPage method to read the records that are displayed in the Recently Viewed records section in the Action bar in the Oracle CRM On Demand application.

The following are attributes of the <ListOfHistoryItem> element that you can specify:

• pagesize. Determines the maximum number of records displayed on a page following a query.

• startrownum. Indicates the row from which the HistoryQueryPage method starts to return records.

• recordcountneeded. Indicates whether a record count for the query is to be returned.

Each of the child elements of <ListOfHistoryItem> can have the following attributes:

• sortorder. Determines the sort order for the records returned by the query, either ASC for ascending or DESC for descending.

• sortsequence. An integer value that determines the order of the sort specification.

The following are attributes of the <HistoryItemData> element that can be returned:

• recordcount. An integer value that indicates the record count.

• lastpage. A value that indicates whether or not the last value in the query set has been returned.

Arguments

The following table describes the arguments taken by the HistoryQueryPage method.

Table Arguments Taken by the HistoryQueryPage Method

Name	Description	Required	Default	I/O
ListOfHistoryItem	The list of records queried (input), and after query execution, the list of records returned (output).	Yes	Not applicable	Input/Output

Return Value of the Call

A list of recently viewed records. The following are the child elements of ListOfHistory:

• Id. The row ID of the record.

• CreatedById. One of the standard audit fields, see Audit Fields.

• CreatedDate. One of the standard audit fields, see Audit Fields.

• CreatedBy. One of the standard audit fields, see Audit Fields.

• ModifiedById. One of the standard audit fields, see Audit Fields.

• ModifiedDate. One of the standard audit fields, see Audit Fields.

• ModifiedBy. One of the standard audit fields, see Audit Fields.

• ModId. The modification key.

• ObjectName. The system name of the object.

• ObjectId. The object ID of the record.

• ObjectDisplay. The display name of the record.

• Order. A sequence number. Recently viewed records are displayed in the UI in descending order. If two records have the same <Order> value, then <CreatedDate> is considered.

• RecordCreated. The date and time the record was created.

• RecordType. The record type.

Sample SOAP Request - HistoryQueryPage

The following SOAP request retrieves all of the records from the Recently Viewed list.

<?xml version="1.0" encoding="utf-8" standalone="no"?>
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" 
xmlns:his="urn:crmondemand/ws/history/" xmlns:quer="urn:/crmondemand/xml/historyitem/Query">
<soapenv:Header/>
   <soapenv:Body>
      <his:HistoryQueryPage_Input>
         <quer:ListOfHistoryItem>
            <quer:HistoryItem>
               <quer:Id></quer:Id>
               <quer:CreatedById></quer:CreatedById>
               <quer:CreatedDate></quer:CreatedDate>
               <quer:CreatedBy></quer:CreatedBy>
               <quer:ModifiedById></quer:ModifiedById>
               <quer:ModifiedDate></quer:ModifiedDate>
               <quer:ModifiedBy></quer:ModifiedBy>
               <quer:ModId></quer:ModId>
               <quer:ObjectName></quer:ObjectName>
               <quer:ObjectId></quer:ObjectId>
               <quer:ObjectDisplay></quer:ObjectDisplay>
               <quer:Order></quer:Order>
               <quer:RecordCreated></quer:RecordCreated>
               <quer:RecordType></quer:RecordType>
            </quer:HistoryItem>
         </quer:ListOfHistoryItem>
      </his:HistoryQueryPage_Input>
   </soapenv:Body>
</soapenv:Envelope>

Sample SOAP Response - HistoryQueryPage

The following SOAP response contains ten items from the Recently Viewed list (only two items are shown):

<?xml version="1.0" encoding="utf-8" standalone="no"?>
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" 
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
   <SOAP-ENV:Body>
      <ns:HistoryQueryPage_Output xmlns:ns="urn:crmondemand/ws/history/">
         <ListOfHistoryItem lastpage="false" xmlns="urn:/crmondemand/xml/historyitemData">
            <HistoryItem>
               <Id>1QA2-33GUI8</Id>
               <CreatedById>1-CZ010</CreatedById>
               <CreatedDate>2018-01-02T08:18:03Z</CreatedDate>
               <CreatedBy>Tara Treadlightly, 01/02/2018 03:18:03</CreatedBy>
               <ModifiedById>1-CZ010</ModifiedById>
               <ModifiedDate>2018-01-02T08:18:03Z</ModifiedDate>
               <ModifiedBy>Tara Treadlightly, 01/02/2018 03:18:03</ModifiedBy>
               <ModId>0</ModId>
               <ObjectName>ServiceQuota</ObjectName>
               <ObjectId>1QA2!591</ObjectId>
               <ObjectDisplay>Web Services Operations Allotment</ObjectDisplay>
               <Order>28</Order>
               <RecordCreated>2018-01-02T08:18:03Z</RecordCreated>
               <RecordType/>
            </HistoryItem>
...
...
            <HistoryItem>
              <Id>1QA2-33GUIH</Id>
              <CreatedById>1-CZ010</CreatedById>
              <CreatedDate>2018-01-02T08:18:03Z</CreatedDate>
              <CreatedBy>Tara Treadlightly, 01/02/2018 03:18:03</CreatedBy>
              <ModifiedById>1-CZ010</ModifiedById>
              <ModifiedDate>2018-01-02T08:18:03Z</ModifiedDate>
              <ModifiedBy>Tara Treadlightly, 01/02/2018 03:18:03</ModifiedBy>
              <ModId>0</ModId>
              <ObjectName>Product</ObjectName>
              <ObjectId>1QA2-1AV5FQ</ObjectId>
              <ObjectDisplay>WSPRD2</ObjectDisplay>
              <Order>37</Order>
              <RecordCreated>2018-01-02T08:18:03Z</RecordCreated>
              <RecordType/>
            </HistoryItem>
         </ListOfHistoryItem>
      </ns:HistoryQueryPage_Output>
      </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

LeadConvert

Converts leads to accounts, contacts, deal registrations, or opportunities.

Usage

You use the LeadConvert method to convert leads. To download the Lead Conversion WSDL and to convert leads using Web service calls, the Convert Leads privilege must be enabled for your user role. You can create account, contact, deal registration, and opportunity records, or copy lead information to existing records by converting the lead record. Depending on your company’s settings, the new opportunity record can include information that affects revenue calculations.

If the necessary options are available in the lead conversion layouts, you can also do the following:

• Copy the members of the lead team to the team on the account, contact, and opportunity that are created or linked to the lead during the conversion process. You can also determine the record access level to grant to the lead owner in the team.

• Link the lead’s associated custom object records to the account, contact, and opportunity that are created or linked to the lead during the conversion process. Custom Objects 01 through 40 are supported.

The LeadConvert method provides the same functionality that is available in the Lead Convert page in the UI. For conversion, a contact record is required, either an existing contact record or a new record.

The following table shows how the fields in the Lead Convert UI page map to fields used in LeadConvert Web service requests.

Table Mapping of Lead Convert Page Fields to Lead Convert Fields

UI Field	LeadConvert Method Field	Comments
Account Fields
Associated Account	AccountName	For existing accounts. The following fields can be used to pick an existing account: - Id, ExternalSystemId, AccountName and Location.
Account Name	AccountName	For new accounts.
Copy Lead Team	CopyLeadTeamtoAccount	Possible values: true or false, 1 or 0.
Lead Owner Record Access in Account Team	AccountTeamLeadOwnerAccess	The record access level to grant to the lead owner in the account team.
Associate Custom Object 01 through Associate Custom Object 40	AssociateCO1ToAccount through AssociateC40ToAccount	Possible values: true or false, 1 or 0.
Contact Fields
Associated Contact	ContactFirstName ContactLastName	For existing contacts. The following fields can be used to pick an existing contact: Id, ExternalSystemId, ContactFirstName and ContactLastName.
Contact First Name	ContactFirstName	Required in a conversion request
Contact Last Name	ContactLastName	Required in a conversion request
Copy Lead Team	CopyLeadTeamtoContact	Possible values: true or false, 1 or 0.
Lead Owner Record Access in Contact Team	Contact TeamLeadOwnerAccess	The record access level to grant to the lead owner in the contact team.
Associate Custom Object 01 through Associate Custom Object 40	AssociateCO1ToContact through AssociateC40ToContact	Possible values: true or false, 1 or 0.
Opportunity Fields
Associated Opportunity	OpportunityName	For new opportunities
Potential Revenue	PotentialRevenue	Also a Deal Registration field
Estimated close date	EstimatedCloseDate	Also a Deal Registration field
Next Step	NextStep	Also a Deal Registration field
Description	Description	Also a Deal Registration field
Copy Lead Team	CopyLeadTeamtoOpportunity	Possible values: true or false, 1 or 0.
Lead Owner Record Access in Opportunity Team	OpportunityTeamLeadOwnerAccess	The record access level to grant to the lead owner in the opportunity team.
Associate Custom Object 01 through Associate Custom Object 40	AssociateCO1ToOppty through AssociateC40ToOppty	Possible values: true or false, 1 or 0.
Deal Registration Fields
Deal Registration Name	DealRegistrationName	For new opportunities
Principal Partner Account	PartnerName	Required when converting to a deal registration. Principal Partner Account can be specified using the PartnerName, PartnerId, or PartnerExternalSystemId fields.
Company Name	Company	None

Usually you convert leads that have previously been qualified to opportunities.

You can include up to 20 leads in the request for conversion. You can convert the same lead to an account or contact multiple times, but you can convert a lead to a deal registration or opportunity only once. If you have converted a lead to a deal registration or opportunity, you cannot later convert it to a different deal registration or opportunity. However, a lead that has been converted to a deal registration can also later be converted to a different account or contact.

Arguments

The following table describes the arguments taken by the LeadConvert method.

Table Arguments Taken by the LeadConvert Method

Name	Description	Required	Default	I/O
ListOfLead	The list of leads and associated account, contact, deal registration, and opportunity records.	Yes	Not applicable	Input/Output

Return Value of the Call

The status keys of the converted lead and the account, contact, opportunity, and deal registration records are returned.

Sample SOAP Request - LeadConvert

The following SOAP request creates new account, contact, opportunity, and deal registration records for a lead.

<?xml version="1.0" encoding="utf-8" standalone="no"?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" 
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:wsse="http://docs.oasis-
open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd" xmlns:xsd="http://
www.w3.org/2001/XMLSchema">
   <soap:Header>
      <wsse:Security xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd">
         <wsse:UsernameToken>
            <wsse:Username>%%%USERNAME%%%</wsse:Username>
            <wsse:Password Type="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-username-token-profile-1.0#PasswordText">%%%PASSWORD%%%</wsse:Password>
         </wsse:UsernameToken>
      </wsse:Security>
   </soap:Header>
   <soap:Body>
   <LeadConvert_Input xmlns="urn:crmondemand/ws/leadconvert/">
      <ListOfLead>
         <Lead>
            <LeadFirstName>lead1</LeadFirstName>
            <LeadLastName>test</LeadLastName>
            <Account>
               <AccountName>My New Opty Account</AccountName>
               <Location>Will not show</Location>
            </Account>
            <Contact>
               <ContactFirstName>Converted</ContactFirstName>
               <ContactLastName>Contact</ContactLastName></Contact>
            <Opportunity>
               <OpportunityName>Converted</OpportunityName>
               <PotentialRevenue>2500</PotentialRevenue>
               <EstimatedCloseDate>2015-12-10T05:00:00Z</EstimatedCloseDate>
               <NextStep>Reconvert</NextStep>
               <Description>Converted Lead - Test</Description>
               <ExternalSystemId>LEAD-CONV-DATA</ExternalSystemId>
            </Opportunity>
            <DealRegistration>
              <DealRegistrationName>DR Converted</DealRegistrationName>
              <Company>Test</Company>
              <PotentialRevenue>2500</PotentialRevenue>
              <EstimatedCloseDate>2015-12-10T05:00:00Z</EstimatedCloseDate>
              <NextStep>Reconvert</NextStep>
              <Description>Converted Lead - Test</Description>
              <ExternalSystemId>LEAD-CONV-DR</ExternalSystemId>
              <PartnerName>test</PartnerName>
            </DealRegistration>
         </Lead>
      </ListOfLead>
   </LeadConvert_Input>
   </soap:Body>
</soap:Envelope>

Sample SOAP Response

The following response contains the status keys of the newly-created records:

<?xml version="1.0" encoding="utf-8"?>
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" 
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
   <SOAP-ENV:Body>
      <ns:LeadConvert_Output xmlns:ns="urn:crmondemand/ws/leadconvert/">
         <ListOfLead xmlns="urn:/crmondemand/xml/leadconvert/Data">
            <Lead>
               <Id>1QA2-2EYBDY</Id>
               <ExternalSystemId></ExternalSystemId>
               <ModId>0</ModId>
               <CreatedById>1-CZ10</CreatedById>
               <CreatedDate>2015-12-08T07:52:59Z</CreatedDate>
               <CreatedBy>%%%USERNAME%%%, 2015-12-08T07:52:59Z</CreatedBy>
               <ModifiedDate>2015-12-08T07:52:59Z</ModifiedDate>
               <ModifiedById>1-CZ10</ModifiedById>
               <ModifiedBy>%%%USERNAME%%%, 2015-12-08T07:52:59Z</ModifiedBy>
               <Account>
                 <Id>1QA2-2EXDFQ</Id>
                 <ExternalSystemId></ExternalSystemId>
                 <ModId>0</ModId>
                 <CreatedById>1-CZ10</CreatedById>
                 <CreatedDate>2015-12-08T07:52:59Z</CreatedDate>
                 <CreatedBy>%%%USERNAME%%%, 2015-12-08T07:52:59Z</CreatedBy>
                 <ModifiedDate>2015-12-08T07:52:59Z</ModifiedDate>
                 <ModifiedById>1-CZ10</ModifiedById>
                 <ModifiedBy>%%%USERNAME%%%, 2015-12-08T07:52:59Z</ModifiedBy>
               </Account>
               <Contact>
                 <Id>1QA2-R22RU</Id>
                 <ExternalSystemId></ExternalSystemId>
                 <ModId>0</ModId>
                 <CreatedById>1-CZ10</CreatedById>
                 <CreatedDate>2015-12-08T07:52:59Z</CreatedDate>
                 <CreatedBy>%%%USERNAME%%%, 2015-12-08T07:52:59Z</CreatedBy>
                 <ModifiedDate>2015-12-08T07:52:59Z</ModifiedDate>
                 <ModifiedById>1-CZ10</ModifiedById>
                 <ModifiedBy>%%%USERNAME%%%, 2015-12-08T07:52:59Z</ModifiedBy>
               </Contact>
               <Opportunity>
                 <Id>1QA2-2EY4IO</Id>
                 <ExternalSystemId></ExternalSystemId>
                 <ModId>0</ModId>
                 <CreatedById>1-CZ10</CreatedById>
                 <CreatedDate>2015-12-08T07:52:59Z</CreatedDate>
                 <CreatedBy>%%%USERNAME%%%, 2015-12-08T07:52:59Z</CreatedBy>
                 <ModifiedDate>2015-12-08T07:52:59Z</ModifiedDate>
                 <ModifiedById>1-CZ10</ModifiedById>
                 <ModifiedBy>%%%USERNAME%%%, 2015-12-08T07:52:59Z</ModifiedBy>
               </Opportunity>
               <DealRegistration>
                 <Id>1QA2-2EY41J</Id>
                 <ExternalSystemId></ExternalSystemId>
                 <ModId>0</ModId>
                 <CreatedById>1-CZ10</CreatedById>
                 <CreatedDate>2015-12-08T07:52:59Z</CreatedDate>
                 <CreatedBy>%%%USERNAME%%%, 2015-12-08T07:52:59Z</CreatedBy>
                 <ModifiedDate>2015-12-08T07:52:59Z</ModifiedDate>
                 <ModifiedById>1-CZ10</ModifiedById>
                 <ModifiedBy>%%%USERNAME%%%, 2015-12-08T07:52:59Z</ModifiedBy>
               </DealRegistration>
            </Lead>
         </ListOfLead>
      </ns:LeadConvert_Output>
   </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

LoginHistoryQueryPage

Executes a query against the list of user login history, and returns a subset of the records that match the search criteria set by the method arguments.

Usage

You use the LoginHistoryQueryPage method to view the Login History for a user. This is the same information that is displayed in the Company Administration, Sign In Audit page in the Oracle CRM On Demand application. As an example of how you might use this data, you might save the data in a CSV file and then import it into a spreadsheet. You could then use the spreadsheet to generate a report showing, for example, how often a user logs into Oracle CRM On Demand.

Arguments

The following table describes the arguments taken by the LoginHistoryQueryPage method.

Table Arguments Taken by the LoginHistoryQueryPage Method

Name	Description	Required	Default	I/O
ListOfLoginHistory	The list of object instances queried (input), and after query execution, the list of object instances returned (output).	Yes	Not applicable	Input/Output
PageSize	The maximum number of records displayed on a page following a query.	No	10	Input
StartRowNum	Indicates the row from which the LoginHistoryQueryPage method starts to return records. Use the StartRowNum argument to return a set of records for any given method. For example, if PageSize=100 and you want to return records 1-100, you set StartRowNum to 0. Then, if you want to return records 101-200, you set StartRowNum to 100, and run the query again. You continue doing this until the last page is returned. In this way, you can return all records for a particular query.	No	0	Input
LastPage	A value that indicates whether or not the last value in the query set has been returned.	Not applicable	Not applicable	Output

Return Value of the Call

The following information is returned for each usage record.

A list of user login history. The following are the child elements of ListOfLoginHistory:

• UserId. The user ID of the user.

• FirstName. The user’s first name.

• LastName. The user’s last name.

• UserAlias. The user alias of the user.

• LoginName. The login name for the user.

• LoginStatus. The login status for the user.

• LoginTimestamp. The time at which the user last logged in.

• ClientType. The type of client from which the user logged in.

• IPAddress. The source IP address for the user.

• AdditionalInformation. Additional information for the user.

• LogoutTimestamp. The time at which the user last logged out.

Sample SOAP Request - LoginHistoryQueryPage

The following SOAP request queries against the list of user login history to return a login record that occurred after the timestamp of 08/01/2011 00:00:00. It also demonstrates the use of the optional <PageSize> and <StartRowNum> arguments to return one record at row 1 (second record).

<?xml version="1.0" encoding="utf-8" standalone="no"?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/
XMLSchema-instance" xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-
secext-1.0.xsd" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
   <soap:Header>
      <wsse:Security>
         <wsse:UsernameToken>
            <wsse:Username>%%%USERNAME%%%</wsse:Username>
            <wsse:Password Type="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-username-token-profile-1.0#PasswordText">%%%PASSWORD%%%</wsse:Password>
         </wsse:UsernameToken>
      </wsse:Security>
   </soap:Header>
   <soap:Body>
      <LoginHistoryWS_LoginHistoryQueryPage_Input xmlns="urn:crmondemand/ws/loginhistory/">
         <ListOfLoginHistory>
            <LoginHistory>
               <UserId />
               <FirstName />
               <LastName />
               <UserAlias />
               <LoginName />
               <LoginStatus />
               <LoginTimestamp>&gt;='08/01/2011 00:00:00'</LoginTimestamp>
               <ClientType />
               <IPAddress />
               <AdditionalInformation />
               <LogoutTimestamp />
            </LoginHistory>
         </ListOfLoginHistory>
         <PageSize>1</PageSize>
         <StartRowNum>1</StartRowNum>
      </LoginHistoryWS_LoginHistoryQueryPage_Input>
   </soap:Body>
</soap:Envelope>

Sample SOAP Response

The following response contains the requested login history:

<?xml version="1.0" encoding="utf-8"?>
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://
www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
   <SOAP-ENV:Body>
      <ns:LoginHistoryWS_LoginHistoryQueryPage_Output xmlns:ns="urn:crmondemand/ws/loginhistory/">
         <ns:LastPage>false</ns:LastPage>
         <ListOfLoginHistory xmlns="urn:/crmondemand/xml/loginhistory">
            <LoginHistory>
               <UserId>HRZ780-I5RUE</UserId>
               <FirstName>Joanne</FirstName>
               <LastName>Brown</LastName>
               <UserAlias>Joanne Brown</UserAlias>
               <LoginName>%%%USERNAME%%%</LoginName>
               <LoginStatus>Success</LoginStatus>
               <LoginTimestamp>08/02/2011 13:53:00</LoginTimestamp>
               <ClientType>WS</ClientType>
               <IPAddress>10.156.87.45</IPAddress>
               <AdditionalInformation></AdditionalInformation>
               <LogoutTimestamp>08/02/2011 13:59:00</LogoutTimestamp>
            </LoginHistory>
         </ListOfLoginHistory>
      </ns:LoginHistoryWS_LoginHistoryQueryPage_Output>
   </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

MergeRecords

Merges records for certain record types.

Objects Supported

MergeRecords is supported for the following record types: Account, Accreditation, Address, Allocation, Application, Asset, Broker Profile, Business Plan, Campaign, Certification, Claim, Contact, Contact State License, Course, Coverage, Custom Objects 01 through 40, Damage, Deal Registration, Dealer, Event, Exam, Financial Account, Financial Account Holder, Financial Account Holding, Financial Plan, Financial Product, Financial Transaction, Fund, Fund Request, HCP Contact Allocation, Household, Insurance Property, Involved Party, Lead, MDF Request, Message Plan, Message Plan Item, Message Plan Item Relations, Objective, Opportunity, Partner, Partner Program, Plan Account, Plan Contact, Plan Opportunity, Policy, Policy Holder, Portfolio, Product Indication, Sample Disclaimer, Sample Request, Sample Transaction, Service Request, Solution, Special Pricing Request, Vehicle.

See Oracle Migration Tool On Demand Guide for a reference table about the mappings of object names to the display names for the record types in the Oracle CRM On Demand user interface.

If an invalid object name is provided with the MergeRecords method, then an error message is displayed.

Usage

You use the MergeRecords method to merge records. When you merge two records, you specify the record that you want to keep, which is called the primary record, and the record that is to be deleted, which is called the duplicate record.

You must identify a reference to a primary record and a reference to a duplicate record in the request. To identify the primary record, you must specify either a PrimaryId or a PrimaryExternalSystemId argument. To identify the duplicate record, you must specify either a DuplicateId or a DuplicateExternalSystemId argument.

The following rules apply to merging records:

• Fields in the primary parent record that contain data are retained.

• Fields in the primary record that are blank get the value from the duplicate record, if it has a value and if the MergeWhenPrimaryBlank argument is set to true.

• Fields in the primary parent record that are blank remain blank, if the MergeWhenPrimaryBlank argument is not set, or is set to a value other than true.

The MergeDuplicateBooks argument together with the Enable Merge of Duplicate Record's Books setting in the company profile determine whether the books of duplicate records are added to the primary record:

• If the company profile setting is not selected, OR if the company profile setting is selected AND the MergeDuplicateBooks argument is not set to true, then the duplicate record's books are not added to the primary record.

• If the company profile setting is selected AND the MergeDuplicateBooks argument is set to true, then the duplicate record's books are added to the primary record.

The Merge Web service has the same security restrictions as in the Oracle CRM On Demand UI regarding privilege and record permissions. The merge operation is only allowed for users who have Delete access to the record type or who have the Merge Records Without Delete Access privilege for their role.

The table in the next section describes the arguments taken by MergeRecords.

Possible Reasons for Failure of the Merge Operation

If there are more than 9999 records of any one record type linked to either of the records that you want to merge, then the merge operation will not complete successfully. Also, if there are large numbers of records of any type linked to either of the records that you want to merge, then the merge operation might time out, even if the number of linked records of any one record type does not exceed 9999. Other factors can also cause a merge operation to time out, such as the types of records that are involved in the merge operation, the speed of your network, and the load on the Oracle CRM On Demand database and server. You can work around these issues by doing the following:

• Unlink some of the linked records from the parent record as necessary before you merge the parent records.

• Perform merge operations during off-peak hours.

Table Arguments taken by MergeRecords

Field Name	Description	Required	Default	I/O
PrimaryId	The ID of the primary record.	One of these arguments is required	Not applicable	Input
PrimaryExternalSystemId	The externalsystemID of the primary record.		Not applicable	Input
DuplicateId	The ID of the duplicate record.	One of these arguments is required	Not applicable	Input
DuplicateExternalSystemId	The externalsystemID of the duplicate record.		Not applicable	Input
MergeWhenPrimaryBlank	Determines how records are merged when fields in the primary record are blank.True values are set as Y, Yes, True, or 1.False values are any other values including blanks.	No	False	Input
RecordType	The record type; this is case sensitive.	Yes	Not applicable	Input
MergeDuplicateBooks	Determines whether duplicate record’s books are retained.	No	False	Input

Return Value of the Call

The following four values are returned:

• MergedRecordId. The ID of the merged record, that is, the primary record.

• MergedRecordExternalId. The externalsystemID of the merged record.

• DeletedRecordId. The ID of the deleted record, that is, the duplicate record.

• DeletedRecordExternalId. The externalsystemID of the merged record.

Sample SOAP Request - MergeRecords

The following SOAP request merges a contact record with DuplicateExternalSystemId = abc223 into a contact record with Id = ADSA-93DZIC.

Note: To identify the primary record, you can specify either the <PrimaryId> or <PrimaryExternalSystemId> argument, and to specify the duplicate record you can use either the <DuplicateId> or <DuplicateExternalSystemId> argument.

The sample also demonstrates passing in the optional <MergeWhenPrimaryBlank> argument to copy the value for a field in the duplicate record to the primary record when the field in the primary record is blank.

<?xml version="1.0" encoding="utf-8" standalone="no"?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/
XMLSchema-instance" xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-
secext-1.0.xsd" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
   <soap:Header>
      <wsse:Security>
         <wsse:UsernameToken>
            <wsse:Username>%%%USERNAME%%%</wsse:Username>
            <wsse:Password Type="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-username-token-profile-1.0#PasswordText">%%%PASSWORD%%%</wsse:Password>
         </wsse:UsernameToken>
      </wsse:Security>
   </soap:Header>
   <soap:Body>
      <MergeRecordsWS_MergeRecords_Input xmlns="urn:crmondemand/ws/mergerecords/">
         <PrimaryId>ADSA-93DZIC</PrimaryId>
         <DuplicateExternalSystemId>abc223</DuplicateExternalSystemId>
         <MergeWhenPrimaryBlank>Y</MergeWhenPrimaryBlank>
         <RecordType>Contact</RecordType>
      </MergeRecordsWS_MergeRecords_Input>
   </soap:Body>
</soap:Envelope>

Sample SOAP Response

The following response contains the IDs of the merged and deleted records:

<?xml version="1.0" encoding="utf-8"?>
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://
www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
   <SOAP-ENV:Body>
      <ns:MergeRecordsWS_MergeRecords_Output xmlns:ns="urn:crmondemand/ws/mergerecords/">
         <ns:DeletedRecordExternalSystemId>abc223</ns:DeletedRecordExternalSystemId>
         <ns:DeletedRecordId>ADSA-93ET5I</ns:DeletedRecordId>
         <ns:MergedRecordExternalSystemId>ABC123</ns:MergedRecordExternalSystemId>
         <ns:MergedRecordId>ADSA-93DZIC</ns:MergedRecordId>
      </ns:MergeRecordsWS_MergeRecords_Output>
   </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

MetadataChangeSummaryQueryPage

Gets a summary of changes to various categories of metadata.

Usage

You use the MetadataChangeSummaryQueryPage method to determine whether there have been any metadata changes in Oracle CRM On Demand. Only the relevant changes can be extracted and applied to client applications.

With the Administration Services API, field and picklist data, for example, can be accessed and modified (see, for example, FieldManagementUpsert and PicklistUpsert).

Arguments

The following table describes the arguments taken by the MetadataChangeSummaryQueryPage method.

Table Arguments Taken by the MetadataChangeSummaryQueryPage Method

Name	Description	Required	Default	I/O
ListOfMetadataChangeSummary	The metadata to be queried and returned.	Yes	Not applicable	Input/Output
recordcountneeded	Indicates whether a record count for the query is to be returned.	No	false	Input
PageSize	The maximum number of records displayed on a page following a query.	No	10	Input
StartRowNum	Indicates the row from which the method starts to return records.	No	0	Input
searchspec	Indicates the search specification.	No	Not applicable	Input
sortsequence	An integer value that determines the order of the sort specification.	No		Input
sortorder	Determines the sort order for the records returned by the query, either ASC for ascending or DESC for descending.	No	ASC	Input
LastPage	A value that indicates whether or not the last value in the query set has been returned.	Not applicable	Not applicable	Output
recordcount	An integer value that indicates the record count.	Not applicable	Not applicable	Output

Return Value of the Call

The following information is returned:

• LOVLastUpdated. The date and time of the last picklist update.

• CascPicklistsLastUpdated. The date and time of the last cascading picklist update.

• FieldManagementLastUpdated. The date and time of the last field management data update.

• WorkflowLastUpdated. The date and time of the last workflow update.

• AccessProfileLastUpdated. The date and time of the last access profile update.

• BookOfBusinessLastUpdated. The date and time of the last book update.

• ThemesLastUpdated. The date and time of the last theme update.

Sample SOAP Request - MetadataChangesSummaryQueryPage

The following SOAP request retrieves the summary of changes to various categories of metadata:

<?xml version="1.0" encoding="utf-8" standalone="no"?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/
XMLSchema-instance" xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-
secext-1.0.xsd" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
   <soap:Header>
      <wsse:Security>
         <wsse:UsernameToken>
            <wsse:Username>%%%USERNAME%%%</wsse:Username>
            <wsse:Password Type="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-username-token-profile-1.0#PasswordText">%%%PASSWORD%%%</wsse:Password>
         </wsse:UsernameToken>
      </wsse:Security>
   </soap:Header>
   <soap:Body>
      <MetadataChangeSummaryQueryPage_Input xmlns="urn:crmondemand/ws/metadatachangesummary/">
         <ListOfMetadataChangeSummary>
            <MetadataChangeSummary>
               <LOVLastUpdated />
               <CascPicklistsLastUpdated />
               <FieldManagementLastUpdated />
               <WorkflowLastUpdated />
               <AccessProfileLastUpdated />
               <BookOfBusinessLastUpdated />
               <ThemesLastUpdated />
            </MetadataChangeSummary>
         </ListOfMetadataChangeSummary>
      </MetadataChangeSummaryQueryPage_Input>
   </soap:Body>
</soap:Envelope>

Sample SOAP Response

The following response contains the returned metadata:

<?xml version="1.0" encoding="utf-8"?>
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://
www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
   <SOAP-ENV:Body>
      <ns:MetadataChangeSummaryQueryPage_Output xmlns:ns="urn:crmondemand/ws/metadatachangesummary/">
         <ListOfMetadataChangeSummary xmlns="urn:/crmondemand/xml/metadatachangesummary/Data" lastpage="true">
            <MetadataChangeSummary>
               <LOVLastUpdated>2011-08-04T14:46:19</LOVLastUpdated>
               <CascPicklistsLastUpdated>2011-08-04T15:06:08</CascPicklistsLastUpdated>
               <FieldManagementLastUpdated>2011-08-03T11:36:21</FieldManagementLastUpdated>
               <WorkflowLastUpdated>2016-01-29T11:32:09</WorkflowLastUpdated>
               <AccessProfileLastUpdated>2016-12-01T20:25:14</AccessProfileLastUpdated>
               <BookOfBusinessLastUpdated>2016-12-19T11:43:06</BookOfBusinessLastUpdated>
            </MetadataChangeSummary>
         </ListOfMetadataChangeSummary>
      </ns:MetadataChangeSummaryQueryPage_Output>
   </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

SetPassword

Allows the system administrator to set the passwords of users who use Oracle CRM On Demand.

Usage

You use the SetPassword method to enable external applications to synchronize user passwords. For security reasons the password API is not available by default. If customers want to use SetPassword, they can call Customer Care to have the functionality enabled. There are two privileges:

• Change Company Passwords using Web Services. Enables access to SetPassword.

• Manage Company Password Access. Users (usually administrators) who have been granted this privilege can grant other roles the Change Company Passwords using Web Services privilege.

The API allows for the setting of passwords for one or more users at the same time. For each password that is updated, a corresponding user Audit Trail record is created. A user with the ability to set passwords does not have the ability to update the password of another user who has the ability to set passwords.

Arguments

The following table describes the arguments taken by SetPassword. These are child elements of <ListofUser>.

Allows the system administrator to set the passwords of users who use Oracle CRM On Demand.

Table Arguments Taken by Set Password

Field Name	Description	Required	Default	I/O
UserId	The row ID value of the user record.	Yes	Not applicable	Input/Output
EmailAddr	The user’s email address	No	Not applicable	Input/Output
ExternalSystemId	The external system Id for the user.	No	Not applicable	Input/Output
IntegrationId	The integration Id	No	Not applicable	Input/Output
Password	The password for the user.	Yes	Not applicable	Input/Output

Sample SOAP Request - SetPassword

The following SOAP request updates the password for the users in the request.

<?xml version="1.0" encoding="utf-8" standalone="no"?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/
XMLSchema-instance" xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-
secext-1.0.xsd" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
   <soap:Header>
      <wsse:Security>
         <wsse:UsernameToken>
            <wsse:Username>%%%USERNAME%%%</wsse:Username>
            <wsse:Password Type="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-username-token-profile-1.0#PasswordText">%%%PASSWORD%%%</wsse:Password>
         </wsse:UsernameToken>
      </wsse:Security>
   </soap:Header>
   <soap:Body>
      <PasswordWS_SetPassword_Input xmlns="urn:crmondemand/ws/password/">
         <ListOfUser>
            <User>
               <UserId>HRZ780-KGY67</UserId>
               <EMailAddr />
               <Password>oracletest123</Password>
               <IntegrationId />
               <ExternalSystemId />
            </User>
         </ListOfUser>
      </PasswordWS_SetPassword_Input>
   </soap:Body>
</soap:Envelope>

Sample SOAP Response

The following response contains the status of the request:

<?xml version="1.0" encoding="utf-8"?>
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://
www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
   <SOAP-ENV:Body>
      <ns:PasswordWS_SetPassword_Output xmlns:ns="urn:crmondemand/ws/password/">
         <ns:Status>Success</ns:Status>
      </ns:PasswordWS_SetPassword_Output>
   </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

SetSessionTimeZone

Sets the time zone for a Web Services API session.

Usage

This method sets the time zone for a Web services API session.

The LOVLanguageMode argument determines whether the time zone is a language independent code (LIC) or language dependent value (LDV). If the argument has no value or is not supplied, then LDV is assumed.

An example of a LIC time zone value is:

(GMT+2:00) Cairo

The equivalent LDV time zone for Spanish is:

(GMT+2:00) El Cairo

Arguments

The following table describes the arguments taken by the SetSessionTimeZone method.

Table Arguments Taken by the SetSessionTimeZone Method

Name	Description	Required	Default	I/O
TimeZone	The time zone of the user.	Yes	Not applicable	Input
LOVLanguageMode	Whether the time zone is a language independent code (LIC) or language dependent value (LDV).	No	LDV	Input
CurrentServerTime	The server time zone.	Not applicable	Not applicable	Output

Return Value of the Call

The current server time zone as a LIC or LDV.

Sample SOAP Request - SetSessionTimeZone

The following SOAP request updates the timezone for the current session to (GMT -06:00) Central Time (US & Canada).

<?xml version="1.0" encoding="utf-8" standalone="no"?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/
XMLSchema-instance" xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-
secext-1.0.xsd" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
   <soap:Header>
      <wsse:Security>
         <wsse:UsernameToken>
            <wsse:Username>%%%USERNAME%%%</wsse:Username>
            <wsse:Password Type="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-username-token-profile-1.0#PasswordText">%%%PASSWORD%%%</wsse:Password>
         </wsse:UsernameToken>
      </wsse:Security>
   </soap:Header>
   <soap:Body>
      <TimeWS_SetSessionTimeZone_Input xmlns="urn:crmondemand/ws/time/">
         <TimeZone>(GMT-06:00) Central Time (US &amp; Canada)</TimeZone>
      </TimeWS_SetSessionTimeZone_Input>
   </soap:Body>
</soap:Envelope>

Sample SOAP Response

The following response returns the server time zone set by the request:

<?xml version="1.0" encoding="utf-8"?>
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://
www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
   <SOAP-ENV:Body>
      <ns:TimeWS_SetSessionTimeZone_Output xmlns:ns="urn:crmondemand/ws/time/">
         <ns:CurrentServerTime>(GMT-06:00) Central Time (US &amp; Canada)</ns:CurrentServerTime>
      </ns:TimeWS_SetSessionTimeZone_Output>
   </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

UpdatePicklist

Updates picklist values in Oracle CRM On Demand.

Objects Supported

UpdatePicklist is supported for the same objects as supported by the GetPicklistValues method, see GetPicklistValues.

Usage

You use the UpdatePicklist method to update lists of values, typically in a language-dependent manner.

The ListOfPicklistValues argument contains a sequence of PicklistValues elements, each of which has the following child elements:

• DisplayValue. The display value in the specified language.

• Code. The Language Independent Code (LIC).

• Order. The order of the value in the list.

  Note: If a value for Order is not included in an update request, the value is not automatically updated. The automatic update functionality is only supported in the UI.

• NeedTranslate. Whether the value is needed for translation.

• Disabled. Whether the value is disabled.

• Description. The description of the value in the specified language.

If the CreateNew argument is set to Y, new picklist values are created with the specified values.

If the CreateNew argument is set to Y, new picklist values are created with the specified values from DisplayValue and Order, which are required values.

If the CreateNew argument is set to N, existing picklist values are updated with the specified values from DisplayValue or Code, as long as these values are valid.

You cannot use the UpdatePicklist method to create custom picklists or multi-select picklists. You must create new picklist fields through the Oracle CRM On Demand application UI.

You cannot update read-only picklist fields.

Arguments

The following table describes the arguments taken by the UpdatePicklist method.

Table Arguments Taken by the Update Picklist Method

Name	Description	Required	Default	I/O
RecordType	The record type; this is case insensitive	Yes	Not applicable	Input
FieldName	The name of the picklist field.	Yes	Not applicable	Input
CreateNew	Whether new picklist values are to be created. A value of Y specifies that new picklist values are to be created, the default value of N specifies that picklist values are to be updated.	No	N	Input
ListOfPicklistValue	A sequence of PicklistValue elements containing the picklist values to be updated or added.	Yes	Not applicable	Input
LanguageCode	The language code for the picklist values to be updated, for example, ENU, DEU, FRA, ESN, and so on. If the code is not specified, the default language for the current session’s user is used.	No	User’s Default Language	Input
Status	A string indicating the success of the call or an error message if unsuccessful.	Not applicable	Not applicable	Output

Return Value of the Call

Returns a status string indicating the success or otherwise of the call.

Sample SOAP Requests and Responses

This topic contains sample SOAP requests that invoke UpdatePicklist.

Sample SOAP Request 1 - UpdatePicklist: Create a New Picklist Value

The following SOAP request creates a new picklist value for the CallFrequency picklist of the account record type.

Note: When you create new picklist values, the <Code> element is not taken into consideration, and the LIC will be equal to the <DisplayValue> value.

<?xml version="1.0" encoding="utf-8" standalone="no"?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/
XMLSchema-instance" xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-
secext-1.0.xsd" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
   <soap:Header>
      <wsse:Security>
         <wsse:UsernameToken>
            <wsse:Username>%%%USERNAME%%%</wsse:Username>
            <wsse:Password Type="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-username-token-profile-1.0#PasswordText">%%%PASSWORD%%%</wsse:Password>
         </wsse:UsernameToken>
      </wsse:Security>
   </soap:Header>
   <soap:Body>
      <PicklistWS_UpdatePicklist_Input xmlns="urn:crmondemand/ws/picklist/">
         <RecordType>Account</RecordType>
         <FieldName>CallFrequency</FieldName>
         <CreateNew>Y</CreateNew>
         <ListOfPicklistValues>
            <PicklistValues>
               <Code>BiYearly</Code>
               <DisplayValue>BiYearly_v</DisplayValue>
               <NeedTranslate>N</NeedTranslate>
               <Order>3</Order>
               <Disabled>N</Disabled>
               <Description>Twice a year</Description>
            </PicklistValues>
         </ListOfPicklistValues>
      </PicklistWS_UpdatePicklist_Input>
   </soap:Body>
</soap:Envelope>

Sample SOAP Request 2 - UpdatePicklist: Update an Existing Picklist Value

The following SOAP request updates an existing picklist value for the CallFrequency picklist of the account record type. The picklist value is updated in the user's default language:

<?xml version="1.0" encoding="utf-8" standalone="no"?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/
XMLSchema-instance" xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-
secext-1.0.xsd" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
   <soap:Header>
      <wsse:Security>
         <wsse:UsernameToken>
            <wsse:Username>%%%USERNAME%%%</wsse:Username>
            <wsse:Password Type="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-username-token-profile-1.0#PasswordText">%%%PASSWORD%%%</wsse:Password>
         </wsse:UsernameToken>
      </wsse:Security>
   </soap:Header>
   <soap:Body>
      <PicklistWS_UpdatePicklist_Input xmlns="urn:crmondemand/ws/picklist/">
         <RecordType>Account</RecordType>
         <FieldName>CallFrequency</FieldName>
         <ListOfPicklistValues>
            <PicklistValues>
               <Code>BiYearly_v</Code>
               <DisplayValue>BiYearly</DisplayValue>
               <Order>3</Order>
               <Disabled>N</Disabled>
               <Description>Twice a year</Description>
            </PicklistValues>
         </ListOfPicklistValues>
      </PicklistWS_UpdatePicklist_Input>
   </soap:Body>
</soap:Envelope>

Sample SOAP Request 3 - UpdatePicklist with LanguageCode

The following SOAP request updates an existing picklist value for the CallFrequency picklist of the account record type. The picklist value is updated in French according to the <LanguageCode> value specified in the request:

<?xml version="1.0" encoding="utf-8" standalone="no"?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/
XMLSchema-instance" xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-
secext-1.0.xsd" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
   <soap:Header>
      <wsse:Security>
         <wsse:UsernameToken>
            <wsse:Username>%%%USERNAME%%%</wsse:Username>
            <wsse:Password Type="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-username-token-profile-1.0#PasswordText">%%%PASSWORD%%%</wsse:Password>
         </wsse:UsernameToken>
      </wsse:Security>
   </soap:Header>
   <soap:Body>
      <PicklistWS_UpdatePicklist_Input xmlns="urn:crmondemand/ws/picklist/">
         <RecordType>Account</RecordType>
         <FieldName>CallFrequency</FieldName>
         <CreateNew>N</CreateNew>
         <LanguageCode>FRA</LanguageCode>
         <ListOfPicklistValues>
            <PicklistValues>
               <Code>BiYearly_v</Code>
               <DisplayValue>BiYearly_FRA</DisplayValue>
               <NeedTranslate>N</NeedTranslate>
               <Order>3</Order>
               <Disabled>N</Disabled>
               <Description>Deux fois par an</Description>
            </PicklistValues>
         </ListOfPicklistValues>
      </PicklistWS_UpdatePicklist_Input>
   </soap:Body>
</soap:Envelope>

Sample SOAP Requests

The response is the same for each of the three sample SOAP requests:

<?xml version="1.0" encoding="utf-8"?>
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://
www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
   <SOAP-ENV:Body>
      <ns:PicklistWS_UpdatePicklist_Output xmlns:ns="urn:crmondemand/ws/picklist/">
         <ns:Status>TRUE</ns:Status>
      </ns:PicklistWS_UpdatePicklist_Output>
   </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

UpdateCascadingPicklists

Updates cascading picklist values in Oracle CRM On Demand.

Objects Supported

UpdateCascadingPicklists is supported for the same objects as supported by the GetPicklistValues method, see GetPicklistValues.

Usage

You use the UpdateCascadingPicklists method to update cascading picklists, typically in a language-dependent manner.

The ListOfCascadingPicklistsValue argument contains a sequence of ParentCascPicklistsValue elements, which have the following child elements:

• ParentDisplayValue. A display value in the specified language.

• ParentCode. A parent Language Independent Code (LIC).

• ListOfChildPickListValue. A sequence of ChildPicklistValue elements containing the related picklist values that correspond to the parent picklist value.

The ChildPicklistValue element contains the following child elements:

• DisplayValue. The display value in the specified language.

• Code. The Language Independent Code (LIC).

If the CreateNew argument is set to Y, a new set of cascading picklist relationships is created with the specified values.

You cannot create a new Picklist field using the UpdateCascadingPicklist method.

Arguments

The following table describes the arguments taken by the UpdateCascadingPicklists method.

Table Arguments Taken by the UpdateCascadingPicklists Method

Name	Description	Required	Default	I/O
RecordType	The record type; this is case insensitive	Yes	Not applicable	Input
ParentFieldName	The name of the parent picklist field.	Yes	Not applicable	Input
FieldName	The name of the related picklist field.	Yes	Not applicable	Input
CreateNew	Whether a new set of cascading picklist relationships between parent and related picklists is to be created with the input values. A value of Y specifies that a new set of relationships is to be created, the default value of N specifies that picklist values are to be updated.	No	N	Input
Description	A description of the cascading picklist.	No	Not applicable	Input
ListOfCascadingPicklistValue	A sequence of ParentCascPicklistValue elements containing the parent picklist values to be updated or added.	Yes	Not applicable	Input
LanguageCode	The language code for the picklist values to be updated, for example, ENU, DEU, FRA, ESN, and so on. If the code is not specified, the default language for the current session’s user is used.	No	User’s Default Language	Input
Status	A string indicating the success of the call or an error message if unsuccessful.	Not applicable	Not applicable	Output

Return Value of the Call

Returns a status string indicating the success or otherwise of the call.

Sample SOAP Requests and Responses

This topic contains sample SOAP requests that invoke UpdateCascadingPicklists.

Sample SOAP Request 1 - UpdateCascadingPicklist: Create a New Cascading Picklist

The following SOAP request creates a new cascading picklist for the Account record type:

<?xml version="1.0" encoding="utf-8" standalone="no"?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/
XMLSchema-instance" xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-
secext-1.0.xsd" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
   <soap:Header>
      <wsse:Security>
         <wsse:UsernameToken>
            <wsse:Username>%%%USERNAME%%%</wsse:Username>
            <wsse:Password Type="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-username-token-profile-1.0#PasswordText">%%%PASSWORD%%%</wsse:Password>
         </wsse:UsernameToken>
      </wsse:Security>
   </soap:Header>
   <soap:Body>
      <PicklistWS_UpdateCascadingPicklists_Input xmlns="urn:crmondemand/ws/picklist/">
         <RecordType>Account</RecordType>
         <ParentFieldName>AccountType</ParentFieldName>
         <FieldName>Priority</FieldName>
         <CreateNew>Y</CreateNew>
         <ListOfCascadingPicklistsValue>
            <ParentCascPicklistsValue>
               <ParentCode>Competitor</ParentCode>
               <ParentDisplayValue>Competitor</ParentDisplayValue>
               <ListOfChildPicklistValue>
                  <ChildPicklistValue>
                     <Code>Low</Code>
                  </ChildPicklistValue>
               </ListOfChildPicklistValue>
            </ParentCascPicklistsValue>
            <ParentCascPicklistsValue>
               <ParentCode>Customer</ParentCode>
               <ListOfChildPicklistValue>
                  <ChildPicklistValue>
                     <Code>Low</Code>
                     <DisplayValue>Low</DisplayValue>
                  </ChildPicklistValue>
                  <ChildPicklistValue>
                     <Code>High</Code>
                     <DisplayValue>High</DisplayValue>
                  </ChildPicklistValue>
               </ListOfChildPicklistValue>
            </ParentCascPicklistsValue>
         </ListOfCascadingPicklistsValue>
      </PicklistWS_UpdateCascadingPicklists_Input>
   </soap:Body>
</soap:Envelope>

Sample SOAP Request 2 - UpdateCascadingPicklist: Update an Existing Cascading Picklist

The following SOAP request updates an existing cascading picklist for the account record type. The picklist value is updated in the user's default language:

<?xml version="1.0" encoding="utf-8" standalone="no"?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/
XMLSchema-instance" xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-
secext-1.0.xsd" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
   <soap:Header>
      <wsse:Security>
         <wsse:UsernameToken>
            <wsse:Username>%%%USERNAME%%%</wsse:Username>
            <wsse:Password Type="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-username-token-profile-1.0#PasswordText">%%%PASSWORD%%%</wsse:Password>
         </wsse:UsernameToken>
      </wsse:Security>
   </soap:Header>
   <soap:Body>
      <PicklistWS_UpdateCascadingPicklists_Input xmlns="urn:crmondemand/ws/picklist/">
         <RecordType>Account</RecordType>
         <ParentFieldName>AccountType</ParentFieldName>
         <FieldName>Priority</FieldName>
         <ListOfCascadingPicklistsValue>
            <ParentCascPicklistsValue>
               <ParentCode>Partner</ParentCode>
               <ParentDisplayValue>Partner</ParentDisplayValue>
               <ListOfChildPicklistValue>
                  <ChildPicklistValue>
                     <Code>Medium</Code>
                  </ChildPicklistValue>
               </ListOfChildPicklistValue>
            </ParentCascPicklistsValue>
            <ParentCascPicklistsValue>
               <ParentCode>Customer</ParentCode>
               <ListOfChildPicklistValue>
                  <ChildPicklistValue>
                     <Code>High</Code>
                     <DisplayValue>High</DisplayValue>
                  </ChildPicklistValue>
               </ListOfChildPicklistValue>
            </ParentCascPicklistsValue>
         </ListOfCascadingPicklistsValue>
      </PicklistWS_UpdateCascadingPicklists_Input>
   </soap:Body>
</soap:Envelope>

Sample SOAP Responses

The response is the same for both of the sample SOAP requests:

<?xml version="1.0" encoding="utf-8"?>
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://
www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
   <SOAP-ENV:Body>
      <ns:PicklistWS_UpdateCascadingPicklists_Output xmlns:ns="urn:crmondemand/ws/picklist/">
         <ns:Status>TRUE</ns:Status>
      </ns:PicklistWS_UpdateCascadingPicklists_Output>
   </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

UserUsageQueryPage

Executes a query against the list of Web Services utilization, and returns a subset of the records that match the search criteria set by the method arguments.

Usage

You use the UserUsageQueryPage method to query the details of your company's Web services utilization. This is the same data that you can view on the Web Services Utilization page in the Oracle CRM On Demand application. As an example of how you might use this data, you might save the data in a CSV file and then import it into a spreadsheet. You could then use the spreadsheet to generate a report showing, for example, how often a user updates his or her records.

In the input request, if you supply a value for UserId in the ListOfUserUsage argument, the method returns the utilization records for the specified user. If you do not have Administrator privileges, you can only specify your own user ID.

If you do not supply a value for UserId in the input request, the method returns:

• The utilization records for the current user, if you do not have Administrator privileges.

• The utilization records for the whole company, if you do have Administrator privileges.

Arguments

The following table describes the arguments taken by the UserUsageQueryPage method.

Table Arguments Taken by the UserUsageQueryPage Method

Name	Description	Required	Default	I/O
ListOfUserUsage	The list of Web service utilization queried (input), and after query execution, the list of Web service utilization returned (output).	Yes	Not applicable	Input/Output
PageSize	The maximum number of records displayed on a page following a query.	No	10	Input
StartRowNum	Indicates the row from which the method starts to return records.	No	0	Input
LastPage	A value that indicates whether or not the last value in the query set has been returned.	Not applicable	Not applicable	Output

Return Value of the Call

The following information is returned for each usage record.

A list of Web service utilization. The following are the child elements of ListOfUserUsage:

• SessionId. The session identifier of the Web service request.

• UserAlias. The user alias of the user who executed the Web service request.

• UserId. The user ID of the user who executed the Web service request.

• WebServiceName. The name of the Web service to which the request was made.

• WebServiceNameSpace. The namespace used in the request.

• Operation. The operation for the Web service request.

• StartTime. The start time of the Web service request.

• EndTime. The end time of the Web service request.

• EntryType. The entry type for the Web service request.

• InputMessageSize. The size of the input message.

• OutputMessageSize. The size of the output message.

• ErrorMsg. Any error message associated with the Web service request.

• ClientName. The name of the client that made the Web service request. This is the <ClientName> parameter from the SOAP header in Web service requests.

• ClientType. The user agent value for the Web service request. For client integrations other than Oracle client integrations, this value defaults to WS.

Sample SOAP Request - UserUsageQueryPage

The following SOAP request returns the list of Web services utilization records. It also demonstrates the use of the optional <PageSize> and <StartRowNum> arguments to return only five records starting at row 2 (third record).

<?xml version="1.0" encoding="utf-8" standalone="no"?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/
XMLSchema-instance" xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-
secext-1.0.xsd" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
   <soap:Header>
      <wsse:Security>
         <wsse:UsernameToken>
            <wsse:Username>%%%USERNAME%%%</wsse:Username>
            <wsse:Password Type="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-username-token-profile-1.0#PasswordText">%%%PASSWORD%%%</wsse:Password>
         </wsse:UsernameToken>
      </wsse:Security>
   </soap:Header>
   <soap:Body>
      <UserUsageWS_UserUsageQueryPage_Input xmlns="urn:crmondemand/ws/userusage/">
         <PageSize>5</PageSize>
         <StartRowNum>2</StartRowNum>
         <ListOfUserUsage>
            <UserUsage>
               <SessionId />
               <UserAlias />
               <UserId />
               <WebServiceName />
               <WebServiceNameSpace />
               <Operation />
               <StartTime />
               <EndTime />
               <EntryType />
               <InputMessageSize />
               <OutputMessageSize />
               <ErrorMsg />
               <ClientName />
               <ClientType />
            </UserUsage>
         </ListOfUserUsage>
      </UserUsageWS_UserUsageQueryPage_Input>
   </soap:Body>
</soap:Envelope>

Sample SOAP Response

The following illustrates the SOAP response. For brevity, a number of <UserUsage> elements are omitted as indicated by the ellipses (...).

<?xml version="1.0" encoding="utf-8"?>
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://
www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
   <SOAP-ENV:Body>
      <ns:UserUsageWS_UserUsageQueryPage_Output xmlns:ns="urn:crmondemand/ws/userusage/">
         <ns:LastPage>false</ns:LastPage>
         <ListOfUserUsage xmlns="urn:/crmondemand/xml/userusage">
            <UserUsage>
               <SessionId>ADSA-920RIQ</SessionId>
               <UserAlias>Joanne Brown</UserAlias>
               <UserId>HRZ780-I5RUE</UserId>
               <WebServiceName></WebServiceName>
               <WebServiceNameSpace></WebServiceNameSpace>
               <Operation>Login</Operation>
               <StartTime>08/02/2011 13:53:00</StartTime>
               <EndTime>08/02/2011 13:53:00</EndTime>
               <EntryType>Login</EntryType>
               <InputMessageSize></InputMessageSize>
               <OutputMessageSize></OutputMessageSize>
               <ErrorMsg></ErrorMsg>
               <ClientName>Acme</ClientName>
               <ClientType>WS</ClientType>
            </UserUsage>
...
...
            <UserUsage>
               <SessionId>ADSA-921BAY</SessionId>
               <UserAlias>Joanne Brown</UserAlias>
               <UserId>HRZ780-I5RUE</UserId>
               <WebServiceName></WebServiceName>
               <WebServiceNameSpace></WebServiceNameSpace>
               <Operation>Logout</Operation>
               <StartTime>08/02/2011 14:38:15</StartTime>
               <EndTime>08/02/2011 14:38:15</EndTime>
               <EntryType>Logout</EntryType>
               <InputMessageSize></InputMessageSize>
               <OutputMessageSize></OutputMessageSize>
               <ErrorMsg></ErrorMsg>
               <ClientName>Acme</ClientName>
               <ClientType>WS</ClientType>
            </UserUsage>
         </ListOfUserUsage>
      </ns:UserUsageWS_UserUsageQueryPage_Output>
   </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

Administrative Services API Calls

The Administrative Services are used to automate the administration of your company's configurations. The Oracle Migration Tool On Demand client is the utility that eliminates the need to manually copy customized configurations from one environment to another. You can use this downloadable client to extract and import specific configuration details and the Administrative Web services provide programmatic access to the configurations.

Note: The Administrative Services must be enabled for your company. To request enablement of the Administrative Services, contact Customer Care.

For more information about the downloadable client, see Oracle Migration Tool On Demand Guide.

The Administrative Services and their methods are as shown in the following table. There are the following methods for services, though not all services have each method, as shown in the table:

• <Configuration>Read. Extracts configuration data matching the input criteria.

• <Configuration>ReadAll. Extracts all configuration data of a particular type for a company.

• <Configuration>QueryPage. Supported for the Sales Process Administrative Service API and the Sales Stage Administrative Service API. Extracts sales process configuration data.

• <Configuration>Upsert. Updates existing configuration data or inserts it, if it does not exist. You can update or insert multiple items within an Upsert call.

• <Configuration>Create. Creates configuration data.

• <Configuration>Delete. Deletes configuration data.

For access to configuration data, various privileges are required, depending on the type of data. The privileges are detailed in theOracle Migration Tool On Demand Guide and are also mentioned in specific topics in this chapter. Users with an Administrator role will have the necessary privileges to use all of the Administrative Services, although read-only access to some configuration data is available for users who are not administrators, see Access to the Administrative Services APIs for Nonadministrative Users.

The Administrative Services do not support stateful login mechanisms, that is, Single Sign-on (SSO), and use of session IDs to authenticate users. For more information about stateful versus stateless session management, see Establishing and Managing the Web Services Session.

Table Administrative Services

Service	Method	Usage
Access Profile	AccessProfileRead	Administering access profile configuration data.
	AccessProfileReadAll
	AccessProfileUpsert
Action Bar Custom Web Applet	ActionBarCustomWebAppletRead	Administering configuration data for action bar Web applets. Note: Reading or upserting of the Report and Dashboard types of custom Web applet is not supported.
	ActionBarCustomWebAppletReadAll
	ActionBarCustomWebAppletUpsert
Action Bar and Global Header Layouts	ActionBarLayoutReadAll	Administering action bar and global header layout configuration data.
	ActionBarLayoutUpsert
Assessment Scripts	SalesAssessmentTemplateRead	Administering assessment script configuration data.
	SalesAssessmentTemplateReadAll
	SalesAssessmentTemplateUpsert
Assignment Rule	AssignmentRuleRead	Administering assignment rule configuration data.
	AssignmentRuleReadAll
	AssignmentRuleUpsert
Assignment Rule Group	AssignmentRuleGroupRead	Administering assignment rule group configuration data.
	AssignmentRuleGroupReadAll
	AssignmentRuleGroupUpsert
Cascading Picklists	CascadingPicklistRead	Administering cascading picklist configuration data.
	CascadingPicklistReadAll
	CascadingPicklistUpsert
Company Profile	CurrentOrganizationRead	Administering the company profile data.
Concatenated Field	ConcatenatedFieldRead	Administering concatenated field configuration data.
	ConcatenatedFieldReadAll
	ConcatenatedFieldUpsert
Currency Picklist	CurrencyRead	Administering currency picklist configuration data.
	CurrencyReadAll
	CurrencyUpsert
Custom HTML Head Tag	CustomHTMLHeadTagRead CustomHTMLHeadTagUpsert	Administering custom HTML Head tag configuration data.
Customize Record Types	CustomRecordTypeRead	Administering customized record type configuration data.
	CustomRecordTypeReadAll
	CustomRecordTypeUpsert
Custom Web Link	CustomWebLinkRead	Administering Web link configuration data. Note: Reading or upserting of the Report and Dashboard types of custom Web link is not supported.
	CustomWebLinkReadAll
	CustomWebLinkUpsert
Custom Web Tab	CustomWebTabDelete	Administering custom Web tab configuration data. Note: Reading or upserting of the Report and Dashboard types of custom Web tab is not supported.
	CustomWebTabRead
	CustomWebTabReadAll
	CustomWebTabUpsert
Detail Page Custom Web Applet	DetailPageCustomWebAppletRead	Administering detail page Web applet configuration data. Note: Reading or upserting of the Report and Dashboard types of custom Web applet is not supported.
	DetailPageCustomWebAppletReadAll
	DetailPageCustomWebAppletUpsert
Dynamic Layout	DynamicLayoutRead	Administering dynamic page layout configuration data.
	DynamicLayoutReadAll
	DynamicLayoutUpsert
Enable Modification Tracking	EnableModificationTrackingRead	Administering modification tracking configuration data.
	EnableModificationTrackingReadAll
	EnableModificationTrackingUpsert
Field Audit Setup	FieldAuditSetupRead	Administering field audit configuration data.
	FieldAuditSetupReadAll
	FieldAuditSetupUpsert
Field Management	FieldManagementCreate	Administering field management configuration data.
	FieldManagementRead
	FieldManagementReadAll
	FieldManagementUpsert
Homepage Layout	HomepageLayoutReadAll	Administering homepage layout configuration data.
	HomepageLayoutUpsert
Home Page Custom Web Applet	HomepageCustomWebAppletRead	Administering homepage Web applet configuration data.
	HomepageCustomWebAppletReadAll
	HomepageCustomWebAppletUpsert
Home Tab Custom Web Applet	HomeTabCustomWebAppletRead	Administering My Homepage tab Web applet configuration data.
	HomeTabCustomWebAppletReadAll
	HomeTabCustomWebAppletUpsert
Industry Picklist	IndustryRead	Administering industry configuration data.
	IndustryReadAll
Integration Event Queue Management	IntegrationEventQueueRead	Administering integration event queue configuration data.
	IntegrationEventQueueReadAll
	IntegrationEventQueueUpsert
Lead Conversion Mapping	LeadConversionMappingRead	Administering lead conversion mappings configuration data.
	LeadConversionMappingReadAll
	LeadConversionMappingUpsert
Lists	ListRead	Administering list configuration data.
	ListReadAll
List Access and Order	ListAccessAndOrderRead	Administering list access and order configuration data.
	ListAccessAndOrderReadAll
	ListAccessAndOrderUpsert
Page Layout Field	PageLayoutFieldRead	Administering field information for page layout configuration data.
	PageLayoutFieldReadAll
	PageLayoutFieldUpsert
Page Layout Related Information	PageLayoutRelatedInformationRead	Administering related information for page layout configuration data.
	PageLayoutRelatedInformationReadAll
	PageLayoutRelatedInformationUpsert
Page Layout Section Translation	PageLayoutFieldReadAll	Administering information for page layout section configuration data.
	PageLayoutFieldUpsert
Picklist	PicklistRead	Administering picklist configuration data.
	PicklistReadAll
	PicklistUpsert
Picklist Value Group	PicklistValueGroupRead	Administering picklist value group configuration data.
	PicklistValueGroupReadAll
	PicklistValueGroupUpsert
Process Administration	ProcessAdministrationRead	Administering process administration configuration data.
	ProcessAdministrationReadAll
	ProcessAdministrationUpsert
Related Information Layout	RelatedInformationLayoutRead	Administering related information for page layout configuration data.
	RelatedInformationLayoutReadAll
	RelatedInformationLayoutUpsert
Report Folders	ReportFolderRead	Administering report and dashboard folder configuration data.
	ReportFolderReadAll
	ReportFolderUpsert
Role Management	RoleRead	Administering role management configuration data.
	RoleReadAll
	RoleUpsert
Sales Category	SalesCategoryRead	Administering sales category configuration data.
	SalesCategoryReadAll
	SalesCategoryUpsert
Sales Process	SalesProcessQueryPage	Administering sales process configuration data.
	SalesProcessInsertOrUpdate
Sales Stage	SalesStageQueryPage	Administering sales stage configuration data.
	SalesStageInsertOrUpdate
Search Layout	SearchLayoutRead	Administering search layout configuration data.
	SearchLayoutReadAll
	SearchLayoutUpsert
SSO Token	SSOTokenRead	Obtaining a Single-Sign On (SSO) token.
Workflow Action	WorkflowActionSetRead	Administering workflow action configuration data.
	WorkflowActionSetReadForRuleSet
	WorkflowActionSetUpsert
	WorkflowActionSetInsertOrUpdate
Workflow Rule	WorkflowRuleSetDelete	Administering workflow rule configuration data
	WorkflowRuleSetRead
	WorkflowRuleSetReadAll
	WorkflowRuleSetUpsert
	WorkflowRuleSetInsertOrUpdate
Workflow User	WorkflowUserSetInsertOrUpdate	Administering workflow user set configuration data
	WorkflowUserSetReadForRuleSet
	WorkflowUserSetDelete

You can download the WSDL file for each service from the Web Services Administration page in the Oracle CRM On Demand application.

All Web Service operations for the Administrative Services are audited automatically. The audits include all successful operations as well as processing errors such as Request Size exceeded, Invalid SOAP request, Rate limit error, and so on. You can find the audit records in the Web Services Utilization page in Oracle CRM On Demand (click Admin, and then Web Services Utilization).

You can view logs for the Oracle Migration Tool On Demand client as described in the Oracle Migration Tool On Demand Guide. Any requests by the client are also captured in the Web Services Utilization page in Oracle CRM On Demand.

The following topics describe each of the methods.

Access to the Administrative Services APIs for Nonadministrative Users

Users with an Administrator role have the necessary privileges to use all of the methods of the Administrative Services. However, for the following services, read-only access is available for users who do not have the Administrator role:

• Access Profile

• Action Bar Custom Web Applet

• Assessment Scripts

• Currency Picklist

• Custom Record Type

• Detail Page Custom Web Applet

• Field Management

• Home Page Custom Web Applet

• Home Tab Custom Web Applet

• Page Layout Field

• Page Layout Related Information

• Picklist

• Role Management

• Workflow Action

• Workflow Rule

Administrators can read, create, update and delete configurations. Other users can only issue Read and ReadAll requests for the services listed; they must only have been granted access to Web services to issue requests (the Enable Web Services Access privilege).

Record Ownership Mode

You can use the Field Management service to determine and configure the record ownership mode for objects. There are three record ownership modes for objects: user mode, book mode, and mixed mode. For information about record ownership modes, including which record types support record ownership modes, see Oracle CRM On Demand Online Help.

You can determine the record ownership mode by using the FieldManagementRead method to examine the Required flag for the Owner and Book fields for an object:

• For user mode, the Required flag is true for the Owner field and false for the Book field.

• For book mode, the Required flag is false for the Owner field and true for the Book field.

• For mixed mode, the Required flag is false for both the Owner field and Book field.

If the Required flag is true for both Owner and Book fields, then the configuration is invalid and no records can be saved until the configuration is fixed.

A SOAP request to determine the record ownership mode must specify the object name, and the system names for the Owner and Book fields. It must also specify true for the IncludeAll argument to ensure that the field information is returned. The following table shows the system names for the Owner and Book fields for some record types.

Table System Names of Owner and Book Fields for Objects

Object	Owner Field	Book Field
Account	Primary Owner Id	Primary Position Id
Activity	Primary Owner Id	Position Id
Contact	Primary Owner Id	Primary Position Id
Opportunity	Primary Owner Id	Primary Position Id
Lead	Owner Id	Primary Position Id

The following is a sample SOAP request to retrieve the record ownership mode information for the Contact object:

<?xml version="1.0" encoding="utf-16"?>
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:fiel="urn:crmondemand/
ws/odesabs/fieldmanagement/" xmlns:quer="urn:/crmondemand/xml/fieldmanagement/query">
   <soapenv:Header>
      <wsse:Security xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd">
         <wsse:UsernameToken wsu:Id="UsernameToken-30489657" xmlns:wsu="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd">
            <wsse:Username>rsbooks/rsinn</wsse:Username>
            <wsse:Password Type="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-username-token-profile-1.0#PasswordText">password</wsse:Password>
         </wsse:UsernameToken>
      </wsse:Security>
   </soapenv:Header>
   <soapenv:Body>
      <fiel:FieldManagementRead_Input>
         <quer:FieldSet>
            <quer:ObjectName>Contact</quer:ObjectName>
            <quer:IncludeAll>true</quer:IncludeAll>
            <quer:ListOfFields>
               <quer:Field>
                  <quer:Name>Primary Owner Id</quer:Name>
                  <quer:Required />
               </quer:Field>
               <quer:Field>
                  <quer:Name>Primary Position Id</quer:Name>
                  <quer:Required />
               </quer:Field>
            </quer:ListOfFields>
         </quer:FieldSet>
      </fiel:FieldManagementRead_Input>
   </soapenv:Body>
</soapenv:Envelope>

The following is the SOAP response, and in this case, Required is false for both the Owner and Book fields, which indicates mixed mode:

<?xml version="1.0" encoding="utf-16"?>
<env:Envelope xmlns:env="http://schemas.xmlsoap.org/soap/envelope/">
   <env:Header />
   <env:Body>
      <fiel:FieldManagementRead_Output xmlns:fiel="urn:crmondemand/ws/odesabs/fieldmanagement/">
         <data:ListOfFieldSet xmlns:data="urn:/crmondemand/xml/fieldmanagement/data">
            <data:FieldSet>
               <data:ObjectName>Contact</data:ObjectName>
               <data:ListOfFields>
                  <data:Field>
                     <data:Name>Primary Owner Id</data:Name>
                     <data:DisplayName>Primary Owner Id</data:DisplayName>
                     <data:Required>false</data:Required>
                  </data:Field>
                  <data:Field>
                     <data:Name>Primary Position Id</data:Name>
                     <data:DisplayName>Book: Id</data:DisplayName>
                     <data:Required>false</data:Required>
                  </data:Field>
               </data:ListOfFields>
            </data:FieldSet>
         </data:ListOfFieldSet>
      </fiel:FieldManagementRead_Output>
   </env:Body>
</env:Envelope>

You can use the FieldManagementUpsert method to set the record ownership mode for an object as required.

AccessProfileRead

Extracts access profile configuration data.

Usage

Use the AccessProfileRead method to extract access profile configuration data matching the input criteria. The Manage Roles and Access privilege is required.

The access profile is specified with the <Name> child element of apQuery:AccessProfile.

You can use the <NameTranslation> and <AccessProfileId> elements of apQuery:AccessProfile to retrieve access profile configuration data. The <NameTranslation> element specifies the access profile name in the user’s language, and the <AccessProfileId> element specifies an access profile ID.

See AccessProfileUpsert for information about the access profile data specified in apData:AccessProfile.

Arguments

The following table describes the arguments taken by the AccessProfileRead method.

Table Arguments Taken by the AccessProfileRead Method

Name	Description	Required	Default	I/O
apQuery:AccessProfile	The access profile query criteria.	Yes	Not applicable	Input
apData:AccessProfile	The extracted access profile data.	Not applicable	Not applicable	Output

Return Value of the Call

The access profile is returned.

AccessProfileReadAll

Extracts all of the access profile configuration data for a company.

Usage

Use the AccessProfileReadAll method to read all of the access profiles. The Manage Roles and Access privilege is required.

The input argument <Version> specifies the release of Oracle CRM On Demand for which configuration data is returned. The default value is 27, and specified values up to and including 27 return configuration data applicable to Oracle CRM On Demand Release 27.

If the value specified is greater than 27, then all of the configuration data up to the release specified is returned. For example, if a value of 28 is specified, then all of the configuration data in Release 27 plus the newer data up to Release 28 is returned (which includes the <NameTranslation> and <AccessProfileID> elements).

See AccessProfileUpsert for information about the access profile data specified in apData:AccessProfile.

Arguments

The following table describes the arguments taken by the AccessProfileReadAll method.

Table Arguments Taken by the AccessProfileReadAll Method

Name	Description	Required	Default	I/O
Version	Specifies the release of Oracle CRM On Demand for which configuration data is returned.	No	27	Input
apData:ListOfAccessProfile	The extracted data for all access profiles.	Not applicable	Not applicable	Output

Return Value of the Call

The access profiles are returned.

AccessProfileUpsert

Updates an existing access profile or inserts a new access profile.

Usage

Use the AccessProfileUpsert method to insert a profile or update an existing access profile. The Manage Roles and Access privilege is required.

The apdata:AccessProfile argument contains the following elements containing access profile data:

• Name. The name of the access profile. When performing an insert operation, this name is used as the display name, if a display name is not provided in the <AccessProfileTranslation> element.

• NameTranslation. The name of the access profile in the user’s language. This element is read-only and is ignored for upsert requests.

• AccessProfileId. The access profile ID. This element is read-only and is ignored for upsert requests.

• Description. A description of the access profile.

• AvailableForTeam. Whether the profile can be assigned to team members.

• AvailableForBook. Whether the profile can be assigned to book users.

• Disabled. Whether the profile cannot be assigned, but existing assignments continue to work.

• ListOfAccessProfileTranslation. The text fields in the languages activated for your company:

  • LanguageCode. The three-letter language code for the language.

  • Title. The display name of the access profile in the language identified by the language code.

  • Description. The description of the access profile in the language identified by the language code.

• ListOfAccessProfileEntry. The access rights defined on the access profile for each object and child object:

• AccessObjectName. The names of objects as used in access profiles.

• PermissionCode. The permission codes corresponding to the various access levels for objects.

See Oracle Migration Tool On Demand Guide for reference tables about the following:

• Mappings of three-letter language codes to languages.

• Mappings of access profile object names to the display names for the objects in the Oracle CRM On Demand user interface.

• The permission codes for the various access levels in Oracle CRM On Demand.

Note: The Period object is not supported for the AccessProfileUpsert method in Oracle CRM On Demand Release 23 and later.

Arguments

The following table describes the arguments taken by the AccessProfileUpsert method.

Table Arguments Taken by the AccessProfileUpsert Method

Name	Description	Required	Default	I/O
apData:AccessProfile	The access profile data to be inserted or updated.	Yes	Not applicable	Input
Status	The status of the call.	Not applicable	Not applicable	Output

Return Value of the Call

The status is returned.

ActionBarCustomWebAppletRead

Extracts action bar Web applet configuration data.

Usage

Use the ActionBarCustomWebAppletRead method to read configuration data for an action bar Web applet.

The Web applet is specified with the <DisplayName> child element of apQuery:ActionBarCustomWebApplet.

See ActionBarCustomWebAppletUpsert for information about the data specified in apData:ListOfActionBarCustomWebApplet.

Arguments

The following table describes the arguments taken by the ActionBarCustomWebAppletRead method.

Table Arguments Taken by the ActionBarCustomWebAppletRead Method

Name	Description	Required	Default	I/O
apQuery:ActionBarCustomWebApplet	The Web applet query criteria.	Yes	Not applicable	Input
apData:ListOfActionBarCustomWebApplet	The extracted data for the Web applet.	Not applicable	Not applicable	Output

Return Value of the Call

The Web applet data is returned.

ActionBarCustomWebAppletReadAll

Extracts all of the action bar Web applet configuration data for a company.

Usage

Use the ActionBarCustomWebAppletReadAll method to read all of the action bar Web applets.

The input argument <Version> specifies the release of Oracle CRM On Demand for which configuration data is returned. The default value is 27, and specified values up to and including 27 return configuration data applicable to Oracle CRM On Demand Release 27.

If the value specified is greater than 27, then all of the configuration data up to the release specified is returned. For example, if a value of 28 is specified, then all of the configuration data in Release 27 plus the newer data up to Release 28 is returned.

See ActionBarCustomWebAppletUpsert for information about the data specified in apData:ListOfActionBarCustomWebApplet.

Arguments

The following table describes the arguments taken by the ActionBarCustomWebAppletReadAll method.

Table Arguments Taken by the ActionBarCustomWebAppletReadAll Method

Name	Description	Required	Default	I/O
Version	Specifies the release of Oracle CRM On Demand for which configuration data is returned.	No	27	Input
apData:ListOfActionBarCustomWebApplet	The extracted data for all action bar Web applets.	Not applicable	Not applicable	Output

Return Value of the Call

The action bar Web applets are returned.

ActionBarCustomWebAppletUpsert

Updates an existing action bar Web applet or inserts a new Web applet.

Usage

Use the ActionBarCustomWebAppletUpsert method to insert or update an existing action bar Web applet.

If the Enable Language Translation Support for Web Applets check box is selected in the company profile, then you can use the <LanguageCode> and <DisplayName> child elements of the <Translation> element to insert or update translations of the Web applet display name in each language for your company.

The apData:ActionBarCustomWebApplet argument contains the following elements containing action bar Web applet data:

• DisplayName. The name of the Web applet. Required.

• DisplayNameCurrentUserLang. The name of the Web applet in the language of the currently logged-in user.

• Description. A description for the Web applet.

• Height. The height of the applet in pixels.

• FeedType. Settings for an RSS feed applet:

  • URL. The URL that is invoked when the user clicks the hyperlink.

  • OverrideURLFlag. Whether or not the user can override the URL.

  • TargetWindow. The window in which the Web applet opens: Current Window or New Window.

• HTMLType. Settings for an HTML Web applet:

  • HTMLHeader. HTML code used in an <iframe> element within the HTML header of the page to which you add the Web applet.

  • HTMLBody. HTML code used in an <iframe> element within the HTML body of the page to which you add the Web applet.

  • AlwaysRun. Whether the Web applet will be executed if the applet is minimized.

• URLType Settings for a URL Web applet:

  • URL The URL that is invoked when the user clicks the hyperlink.

  • AlwaysRun Whether the Web applet will be executed if the applet is minimized.

• ReportType. Settings for a Report Web applet:

  Note: The display of prompts for an analysis in the Action bar is not supported, therefore there is no <ReportPrompts> element.

  • ReportPath. The path to the report, which must be located under Shared Folders (required).

  • ReportParameters. The filters that will be applied to the report at runtime. For example: <data:ReportParameters>P0=1&amp;P1=eq&amp;P2="Account"."Account ID"&amp;P3=%%%Row_Id%%%</data:ReportParameters>. The filter syntax is validated when you insert or update. For more information about specifying parameters, see Oracle CRM On Demand Online Help.

  • RefreshLink. Whether the Refresh link that allows users to refresh the report is available at runtime.

  • PrintLink. Whether the Print link that allows users to print the report is available at runtime.

  • ExportLink. Whether the Export link that allows users to download the report is available at runtime.

  • AlwaysRun. Whether the Web applet will be executed if the applet is minimized.

• DashboardType. Settings for a Dashboard Web applet.

  • DashboardPath. The path to the dashboard (required). The dashboard must be located directly in the Dashboards folder under Shared Folders and not at a deeper level. This validation is enforced only in the UI and not via Web service Upsert calls.

  • DashboardParameters. The filters that will be applied to the dashboard at runtime. For example: <data:DashboardParameters>P0=1&amp;P1=eq&amp;P2="Account"."Account ID"&amp;P3=%%%Row_Id%%%</data:DashboardParameters>. The filter syntax is validated when you insert or update. For more information about specifying parameters, see Oracle CRM On Demand Online Help.

  • AlwaysRun. Whether the Web applet will be executed if the applet is minimized.

• ListOfTranslation. The display names in the languages activated for your company:

  • LanguageCode. The three-letter language code for the language.

  • DisplayName. The display name of the custom Web applet in the language identified by the language code.

See Oracle Migration Tool On Demand Guide for reference tables about the following:

• Mappings of three-letter language codes to languages.

See Oracle CRM On Demand Online Help for more information about creating Web applets.

Arguments

The following table describes the arguments taken by the ActionBarCustomWebAppletUpsert method.

Table Arguments Taken by the ActionBarCustomWebAppletUpsert Method

Name	Description	Required	Default	I/O
apData:ActionBarCustomWebApplet	The Web applet data to be inserted or updated.	Yes	Not applicable	Input
Status	The status of the call.	Not applicable	Not applicable	Output

Return Value of the Call

The status is returned.

ActionBarLayoutReadAll

Extracts all of the action bar and global header layout configuration data for a company.

Usage

Use the ActionBarLayoutReadAll method to read all of the action bar and global header layouts.

The input argument <Version> specifies the release of Oracle CRM On Demand for which configuration data is returned. The default value is 26, and specified values up to and including 26 return configuration data applicable to Oracle CRM On Demand Release 26.

If the value specified is greater than 26, then all of the configuration data up to the release specified is returned. For example, if a value of 27 is specified, then all of the configuration data in Release 26 plus the newer data up to Release 27 is returned.

See ActionBarLayoutUpsert for information about the layout data specified in ablData:ActionBarLayout.

Arguments

The following table describes the arguments taken by the ActionBarLayoutReadAll method.

Table Arguments Taken by the ActionBarLayoutReadAll Method

Name	Description	Required	Default	I/O
Version	Specifies the release of Oracle CRM On Demand for which configuration data is returned.	No	26	Input
ablData:ListOfActionBarLayout	The extracted data for all layouts.	Not applicable	Not applicable	Output

Return Value of the Call

The layouts are returned.

ActionBarLayoutUpsert

Updates an existing action bar and global header layout or inserts a new layout.

Usage

Use the ActionBarLayoutUpsert method to insert or update an existing action bar and global header layout.

The abldata:ActionBarLayout argument contains the following elements containing layout data:

• LayoutName. The name of the layout.

• Description. A description of the layout.

• ListOfSections. Contains all of the available sections for the layout. The data for a particular section is contained in the following elements:

• Name. The name of the section, which can be a custom Web applet configured for the action bar, or one of the following:

  • Calendar Action Applet

  • Global Search Multi Field

  • Quick Create

  • Quick Favorite Lists

  • Quick Favorite Records

  • Quick History

  • Quick Message Center

• Displayed. Whether the section is displayed in the action bar.

• Sequence. The position of the section within the action bar layout. This corresponds to step 2 in the Action Bar and Global Header Layouts wizard in the UI. The integer value can be one of the following:

  • -3. The section is in the Global Header Available Sections list.

  • -2. The section is in the Not Available Sections list.

  • -1. The section is in the Action Bar Available Sections list.

  • Positive integers. The section is in the Action Bar Displayed Sections list. The integer value indicates the location of the section within the list, with 0 (zero) meaning the section is located at the top of the list.

• GlobalHeaderSection. Whether the section is a global header section.

• ListOfGlobalHeaders. Contains the details for the global header section, and the data for a global header section is contained in the following elements:

  • Order. The order in which the section is displayed in the global header (required).

  • Icon. The name of the icon for the section (required).

  • Applet. The name of the section (required).

  • AppletWidth. The width of the section (required).

  • AppletDescription. A description.

See Oracle Migration Tool On Demand Guide for information about mappings of action bar section names to the display names for the sections in the Oracle CRM On Demand user interface.

Arguments

The following table describes the arguments taken by the ActionBarLayoutUpsert method.

Table Arguments Taken by the ActionBarLayoutUpsert Method

Name	Description	Required	Default	I/O
ablData:ActionBarLayout	The layout data to be inserted or updated.	Yes	Not applicable	Input
Status	The status of the call.	Not applicable	Not applicable	Output

Return Value of the Call

The status is returned.

AssignmentRuleRead

Extracts assignment rule configuration data.

Usage

Use the AssignmentRuleRead method to extract the assignment rule data matching the input criteria. The Data Rules and Assignment privilege is required.

An assignment rule is specified with the following child elements of apQuery:AssignmentRule:

• <RuleGroupName> + <RecordType> + <RuleName>

Arguments

The following table describes the arguments taken by the AssignmentRuleRead method.

Table Arguments Taken by the AssignmentRuleRead Method

Name	Description	Required	Default	I/O
apQuery:AssignmentRule	The assignment rule query criteria.	Yes	Not applicable	Input
apData:ListOfAssignmentRule	The extracted assignment rule data.	Not applicable	Not applicable	Output

Return Value of the Call

The assignment rule data is returned.

AssignmentRuleReadAll

Extracts all of the assignment rule configuration data for a company.

Usage

Use the AssignmentRuleReadAll method to read all of the assignment rules. The Data Rules and Assignment privilege is required.

There is no input argument; the method simply returns all of the assignment rule data for each of the supported record types: Account, Lead, Opportunity, and Service Request.

See AssignmentRuleUpsert for information about the assignment rule data returned in apData:ListOfAssignmentRule.

Arguments

The following table describes the arguments taken by the AssignmentRuleReadAll method.

Table Arguments Taken by the AssignmentRuleReadAll Method

Name	Description	Required	Default	I/O
apData:ListOfAssignmentRule	The extracted data for all assignment rules.	Not applicable	Not applicable	Output

Return Value of the Call

The assignment rules are returned.

AssignmentRuleUpsert

Updates assignment rule configuration data.

Usage

Use the AssignmentRuleUpsert method to insert or update assignment rule data. The Data Rules and Assignment privilege is required.

The apData:AssignmentRule argument contains the following elements specifying the data for the assignment rule:

• RecordType. The record type: Account, Lead, Opportunity, or Service Request (read-only).

• RuleGroupName. The name of the rule group (read-only).

• RuleName. The name of the rule.

• Order. The order in which the rules are evaluated.

• AssignTo. The user to whom the record is assigned, if the rule criteria are met.

• SendEmailNotification. Whether an email notification is sent.

• AssignToTerritory. For account and opportunity rules only, the territory to which the record is assigned, if the rule criteria are met.

• IncludeTeamAssignment. For account and opportunity rules only, whether team members are assigned to the account, if the rule criteria are met.

• IncludeRelatedContacts. For account rules only, whether contacts linked to the account are assigned to the specified account owner and territory if the rule criteria are met.

• IncludeRelatedOpportunities. For account rules only, whether opportunities linked to the account are assigned to the specified account owner and territory if the rule criteria are met.

• ListOfTeam. Contains the data for team members assigned to the account or opportunity in the following child elements of <Team>:

  • User. The first and last name of the team member (read-only).

  • Role. The role of the team member (read-only).

  • AccountAccess. The access level for accounts.

  • ContactAccess. The access level for contacts.

  • OpportunityAccess. The access level for opportunities.

• ListOfRuleCriteria. Contains the rule criteria for the rule in the following child elements of <Rule>:

  • Field. The name of the field to be evaluated.

  • Condition. The condition to satisfy to meet the criterion.

  • Value. The value for the condition.

  • Sequence. The sequence number for the criterion.

You can use the following combinations of fields to identify rules for upsert operations:

1. <RuleGroupName> + <RecordType> + <RuleName>

2. <RuleGroupName> + <RecordType> + <Order>

If both of these user key combinations have matches, user key 1 takes priority over user key 2.

To identify teams for upsert operations, the user key is the <User> field in <ListOfTeam>.

To identify rule criteria for upsert operations, the user key is the <Sequence> field in <ListOfRuleCriteria>.

For information about assignment rules, see Oracle CRM On Demand Online Help.

Arguments

The following table describes the arguments taken by the AssignmentRuleUpsert method.

Table Arguments Taken by the AssignmentRuleUpsert Method

Name	Description	Required	Default	I/O
apData:ListOfAssignmentRule	The assignment rule data to be updated or inserted.	Yes	Not applicable	Input
Status	The status of the call.	Not applicable	Not applicable	Output

Return Value of the Call

The status is returned.

AssignmentRuleGroupRead

Extracts assignment rule group configuration data.

Usage

Use the AssignmentRuleGroupRead method to extract the assignment rule group data matching the input criteria. The Data Rules and Assignment privilege is required.

You can read assignment rule data for a particular record type and rule group. The record type is specified with the <RecordType> child element and the rule group is specified with the <RuleGroupName> child element of apQuery:AssignmentRuleGroup.

Arguments

The following table describes the arguments taken by the AssignmentRuleGroupRead method.

Table Arguments Taken by the AssignmentRuleGroupRead Method

Name	Description	Required	Default	I/O
apQuery:AssignmentRuleGroup	The assignment rule group query criteria.	Yes	Not applicable	Input
apData:ListOfAssignmentRuleGroup	The extracted assignment rule group data.	Not applicable	Not applicable	Output

Return Value of the Call

The assignment rule group data is returned.

AssignmentRuleGroupReadAll

Extracts all of the assignment rule group configuration data for a company. The Data Rules and Assignment privilege is required.

Usage

Use the AssignmentRuleGroupReadAll method to read all of the assignment rule groups.

There is no input argument; the method simply returns all of the assignment rule group data for each of the supported record types: Account, Lead, Opportunity, and Service Request.

See AssignmentRuleGroupUpsert for information about the assignment rule group data returned in apData:ListOfAssignmentRuleGroup.

Arguments

The following table describes the arguments taken by the AssignmentRuleGroupReadAll method.

Table Arguments Taken by the AssignmentRuleGroupReadAll Method

Name	Description	Required	Default	I/O
apData:ListOfAssignmentRuleGroup	The extracted data for all assignment rule groups.	Not applicable	Not applicable	Output

Return Value of the Call

The assignment rule groups are returned.

AssignmentRuleGroupUpsert

Updates assignment rule group configuration data.

Usage

Use the AssignmentRuleGroupUpsert method to insert or update assignment rule group data. The Data Rules and Assignment privilege is required.

The apData:AssignmentRuleGroup argument contains the following elements specifying the data for the assignment rule group:

• RecordType. The record type: Account, Lead, Opportunity, or Service Request.

• RuleGroupName. The name of the rule group.

• Active. Whether the rule group is active.

• UnassignedOwner. A user who inherits the records that are not assigned by one of the rules.

• UnassignedTerritory. For account and opportunity rule groups only, a territory that inherits the records that are not assigned by one of the rules.

• ReturnEmail. For lead and service request rule groups only, the email address that appears in the Sender field in the email notifications that are sent to the owners of leads and service requests.

• ListOfRule. Contains all of the rule data, in the following child elements of <AssignmentRule>:

  • RuleName. The name of the rule.

  • Order. The order in which the rules are evaluated.

  • AssignTo. The user to whom the record is assigned, if the rule criteria are met.

  • EmailNotification. Whether an email notification is sent to the user to whom the record is assigned. This field is applicable for the Service Request record type only.

  • AssignToTerritory. For account and opportunity rules only, the territory to which the record is assigned, if the rule criteria are met.

  • IncludeTeamAssignment. For account and opportunity rules only, whether team members are assigned to the account, if the rule criteria are met.

  • IncludeRelatedContacts. For account rules only, whether contacts linked to the account are assigned to the specified account owner and territory if the rule criteria are met.

  • IncludeRelatedOpportunities.. For account rules only, whether opportunities linked to the account are assigned to the specified account owner and territory if the rule criteria are met.

You use <RecordType> + <RuleGroupName> to identify rule groups for upsert operations.

You can use the following combinations of fields to identify rules for upsert operations:

1. <RuleGroupName> + <RecordType> + <RuleName>

2. <RuleGroupName> + <RecordType> + <Order>

If both of these user key combinations have matches, user key 1 takes priority over user key 2. Upserts without a value for <Order> return an error.

For information about assignment rules, see Oracle CRM On Demand Online Help.

Arguments

The following table describes the arguments taken by the AssignmentRuleGroupUpsert method.

Table Arguments Taken by the AssignmentRuleGroupUpsert Method

Name	Description	Required	Default	I/O
apData:AssignmentRuleGroup	The assignment rule group data to be updated or inserted.	Yes	Not applicable	Input
Status	The status of the call.	Not applicable	Not applicable	Output

Return Value of the Call

The status is returned.

CascadingPicklistRead

Extracts cascading picklist configuration data for an object.

Usage

Use the CascadingPicklistRead method to extract the set of cascading picklist data matching the input criteria.

The object is specified with the <ObjectName> child element of apQuery:CascadingPicklistSet. You can also specify a particular parent picklist or related picklist in the query.

The apData:ListOfCascadingPicklistSet output argument can contain any number of CascadingPicklist elements, each of which contains the following data:

• ParentPicklist. The parent picklist.

• RelatedPicklist. The related picklist.

• Description. The description of the cascading picklist.

• ListOfPicklistValueAssociations. Contains all the associations for a cascading picklist. The associations for a particular picklist are contained in the following elements:

  • ParentPicklistValue A parent picklist value for the cascading picklist.

  • RelatedPicklistValue The related values for the parent picklist. There is one these elements for each related picklist value.

Arguments

The following table describes the arguments taken by the CascadingPicklistRead method.

Table Arguments Taken by the CascadingPicklistRead Method

Name	Description	Required	Default	I/O
apQuery:CascadingPicklistSet	The cascading picklist query criteria.	Yes	Not applicable	Input
apData:ListOfCascadingPicklistSet	The extracted cascading picklist data.	Not applicable	Not applicable	Output

Return Value of the Call

The cascading picklist data for the object is returned.

CascadingPicklistReadAll

Extracts all of the cascading picklist configuration data for a company.

Usage

Use the CascadingPicklistReadAll method to read all of the cascading picklists.

The input argument <Version> specifies the release of Oracle CRM On Demand for which configuration data is returned. The default value is 39, and specified values up to and including 39 return configuration data applicable to Oracle CRM On Demand Release 39.

If the value specified is greater than 39, then all of the configuration data up to the release specified is returned. For example, if a value of 40 is specified, then all of the configuration data in Release 39 plus the newer data up to Release 40 is returned (which includes the <SharedPicklistFlg> element).

See CascadingPicklistRead for information about the cascading picklist data returned in apData:ListOfCascadingPicklistSet.

Arguments

The following table describes the arguments taken by the CascadingPicklistReadAll method.

Table Arguments Taken by the CascadingPicklistReadAll Method

Name	Description	Required	Default	I/O
Version	Specifies the release of Oracle CRM On Demand for which configuration data is returned.	No	39	Input
apData:ListOfCascadingPicklistSet	The extracted data for all cascading picklists.	Not applicable	Not applicable	Output

Return Value of the Call

The cascading picklists are returned.

CascadingPicklistUpsert

Updates cascading picklist configuration data for a company.

Usage

Use the CascadingPicklistUpsert method to insert or update a cascading picklist.

The apData:CascadingPicklistSet argument contains the following elements specifying the data for the cascading picklist:

• ObjectName. The name of the object.

• ListOfCascadingPicklistSet. Contains any number of CascadingPicklist elements, each of which contains the following data:

  • ParentPicklist. The parent picklist.

  • RelatedPicklist. The related picklist.

  • SharedPicklistFlg. Whether shared picklists are enabled. <SharedPicklistFlg> corresponds to the Enable Shared Cascading Picklist check box in UI, and is applicable only for record types that support sharing picklist values. You can only set SharedPicklistFlg to true if both the ParentPicklist and RelatedPicklist fields are shared fields from the same object and constitute a cascading picklist on that object. For more information, see Oracle CRM On Demand Online Help.

  • Description. The description of the cascading picklist.

• ListOfPicklistValueAssociations. Contains all the associations for the cascading picklist. An associations is contained in the following elements:

  • ParentPicklistValue. A parent picklist value for the cascading picklist.

  • RelatedPicklistValue. The related values for the parent picklist. There is one these elements for each related picklist value.

Update occurs when a cascading picklist already exists with the specified <ParentPicklist> and <RelatedPicklist> values otherwise an Insert occurs.

Upsert fails and an error message is returned if:

• The specified parent picklist and related picklist are the same.

• The parent or related picklist references a field that does not exist.

• The parent or related picklist references a field that is not of type picklist.

• The related picklist references a parent picklist that is already referenced by another related picklist.

Arguments

The following table describes the arguments taken by the CascadingPicklistUpsert method.

Table Arguments Taken by the CascadingPicklistUpsert Method

Name	Description	Required	Default	I/O
apData:CascadingPicklistSet	The cascading picklist data to be updated or inserted.	Yes	Not applicable	Input
Status	The status of the call.	Not applicable	Not applicable	Output

Return Value of the Call

The status is returned.

ConcatenatedFieldRead

Extracts concatenated field configuration data.

Usage

Use the ConcatenatedFieldRead method to extract concatenated field configuration data for an object.

The object is specified with the <ObjectName> child element of apQuery:ConcatenatedFieldSet.

See ConcatenatedFieldUpsert for information about the concatenated field configuration data specified in apData:ConcatenatedFieldSet.

Arguments

The following table describes the arguments taken by the ConcatenatedFieldRead method.

Table Arguments Taken by the ConcatenatedFieldRead Method

Name	Description	Required	Default	I/O
apQuery:ConcatenatedFieldSet	The concatenated field query criteria.	Yes	Not applicable	Input
apData:ListOfConcatenatedFieldSet	The extracted concatenated field configuration data.	Not applicable	Not applicable	Output

Return Value of the Call

The concatenated field configuration data is returned.

ConcatenatedFieldReadAll

Extracts all of the concatenated field configuration data for a company.

Usage

Use the ConcatenatedFieldReadAll method to read all of the concatenated field configuration data.

There is no input argument; the method simply returns all of the concatenated field configuration data.

See ConcatenatedFieldUpsert for information about the concatenated field configuration data specified in apData:ConcatenatedFieldSet.

Arguments

The following table describes the arguments taken by the ConcatenatedFieldReadAll method.

Table Arguments Taken by the ConcatenatedFieldReadAll Method

Name	Description	Required	Default	I/O
apData:ListOfConcatenatedFieldSet	The extracted configuration data for all concatenated fields.	Not applicable	Not applicable	Output

Return Value of the Call

The concatenated field configuration data is returned.

ConcatenatedFieldUpsert

Updates concatenated field configuration data or inserts new concatenated field configuration data for an object.

Usage

Use the ConcatenatedFieldUpsert method to insert concatenated field configuration data or update existing concatenated field configuration data for an object.

The object is specified with the <ObjectName> child element of apData:ConcatenatedFieldSet.

The apdata:ConcatenatedFieldSet argument contains the following child elements of <ConcatenatedField> containing concatenated field configuration data:

• Name. The name of the concatenated field. When performing an insert operation, this name is used as the display name, if a display name is not provided in the <DisplayName> element.

• IntegrationTag. The field’s integration tag name.

• DisplayText. The text that is displayed for the concatenated field.

• ListOfConcatenatedFieldTranslations. The concatenated fields in the languages activated for your company:

  • DisplayName. The display name of the concatenated field in the language identified by the language code.

  • DisplayText. The text that is displayed for the concatenated field, in the language identified by the language code.

  • LangCode. The three-letter language code for the language.

See Oracle Migration Tool On Demand Guide for reference tables about the following:

• Mappings of three-letter language codes to languages.

• Mappings of object names to the display names for the objects in the Oracle CRM On Demand user interface.

For more information about concatenated fields, see Oracle CRM On Demand Online Help.

Arguments

The following table describes the arguments taken by the ConcatenatedFieldUpsert method.

Table Arguments Taken by the ConcatenatedFieldUpsert Method

Name	Description	Required	Default	I/O
apData:ConcatenatedFieldSet	The concatenated field configuration data to be inserted or updated.	Yes	Not applicable	Input
Status	The status of the call.	Not applicable	Not applicable	Output

Return Value of the Call

The status is returned.

CurrencyRead

Extracts currency configuration data.

Usage

Use the CurrencyRead method to extract currency configuration data matching the input criteria.

The currency is specified with the <Name> child element of apQuery:Currency.

See CurrencyUpsert for information about the currency data specified in apData:ListOfCurrency.

Arguments

The following table describes the arguments taken by the CurrencyRead method.

Table Arguments Taken by the Currency Read Method

Name	Description	Required	Default	I/O
apQuery:Currency	The currency query criteria.	Yes	Not applicable	Input
apData:ListOfCurrency	The extracted currency data.	Not applicable	Not applicable	Output

Return Value of the Call

The currency data is returned.

CurrencyReadAll

Extracts all of the currency configuration data for a company.

Usage

Use the CurrencyReadAll method to read all of the currency data.

There is no input argument; the method simply returns all of the currency data.

See CurrencyUpsert for information about the currency data specified in apData:ListOfCurrency.

Arguments

The following table describes the arguments taken by the CurrencyReadAll method.

Table Arguments Taken by the CurrencyReadAll Method

Name	Description	Required	Default	I/O
apData:ListOfCurrency	The extracted data for all currencies.	Not applicable	Not applicable	Output

Return Value of the Call

The currency data is returned.

CurrencyUpsert

Updates existing currency data.

Usage

Use the CurrencyUpsert method to update currency data.

It is not possible to define a new currency or delete an existing currency in Oracle CRM On Demand, therefore CurrencyUpsert only supports update and not insertion of data. The only updating supported is the active/inactive setting and symbol for active currencies.

The apdata:Currency argument contains the following elements containing currency data:

• Name. The name of the currency.

• Code. The three-letter code for the currency.

• Symbol. The symbol for the currency.

• IssuingCountry. The country that issues the currency.

• Active. Whether the currency is active for the company.

Arguments

The following table describes the arguments taken by the CurrencyUpsert method.

Table Arguments Taken by the Currency Upsert Method

Name	Description	Required	Default	I/O
apData:Currency	The currency data to be inserted or updated.	Yes	Not applicable	Input
Status	The status of the call.	Not applicable	Not applicable	Output

Return Value of the Call

The status is returned.

CurrentOrganizationRead

Extracts company profile data.

Usage

Use the CurrentOrganizationRead method to extract company profile data.

The apdata:CurrentOrganization argument contains the elements for company profile data. In the following sections, the elements are grouped according to section name in the Company Profile page in the UI. You can infer the display names of the company profile settings from the associated element names. For information about the company profile settings, see Oracle CRM On Demand Online Help.

Company Key Information

The elements related to company key information are as follows:

• CompanyName

• SignInId

• Location

• WebSite

• NumberOfEmployees

• MainPhone

• MainFax

• PrimaryContact

• Status

Company Contact Information

The elements related to company contact information are as follows:

• BillingCity

• BillingCountry

• BillingPostalCode

• BillingProvince

• BillingAddress1

• BillingAddress2

• ShippingCity

• ShippingCountry

• ShippingPostalCode

• ShippingProvince

• ShippingAddress1

• ShippingAddress2

Company Settings

The elements related to company settings are as follows:

• DefaultLanguage

• DefaultLocale

• DefaultCurrency

• DefaultTimeZone

• RecordPreviewMode

• InlineEditEnabled

• MessageCenterEnabled

• RecordTypeAuditableFields

• AuditExpiry

• RelatedInfoFormat

• EnhancedViewforTabsEnabled

• ClassicThemePagingforTabsEnabled

• OrderUsage

• DynamicLayoutPersonalizationEnabled

• WebAppletsTranslationEnabled

• WorkflowMessageTranslationEnabled

• GlobalSearchMethod

• NavigateToDetailPageIfOneRecordIsReturned

• FiscalYearStartMonth

• FiscalYearStartDate

• FiscalCalendarType

• ProductProbabilityAveragingEnabled

• SaveAndAddProductEnabled

• OpportunityRevenueSplitEnabled

• HeadUpDisplay

• ListHeaderFreeze

• SharedAddressesEnabled

• ValidateSharedAddresses

• RecordTypeListsinLookupWindows

• ProvincePicklistEnabled

• ExcludeVehicleOrAssetRecordsfromPortfolio

• AutomaticUpdateofOpportunityTotalsEnabled

• UnicodeCharInEmail

• ExportRequestExpiryDays

• ExportRequestAttachmentExpiryDays

• SaveEmailAddressInLowerCase. This corresponds to the Store Email in Lower Case setting in the UI.

• Note: If your company saved email addresses in mixed case in the past, and if the Store Email in Lower Case check box is selected, then errors can occur when you attempt to use Web services requests or REST API requests on records such as user and contact records where the email addresses are in mixed case. If such issues arise, and if your company wants to store all email addresses in lowercase, then you must update the email addresses that are currently stored in mixed case and change them to lowercase. To edit the email addresses, you must first deselect the Store Email in Lower Case check box. After you finish editing the email addresses, select the Store Email in Lower Case check box again.

• EnableHTMLFormattingFlag

• EmailExpiryDays

• EmailAttachmentExpiryDays

• KeepDisabledPicklistValueOnUpdate

• PreventWSUpdateInactiveCurrenciesFlag

• EnforceProductAndCategoryRelationship

• EnableAuditTrailFieldsToRespectUserLocale

Company Work Week and Calendar Settings

The elements related to work week and calendar settings are as follows:

• Sunday

• Monday

• Tuesday

• Wednesday

• Thursday

• Friday

• Saturday

• DisplayEventsInCalendar

• CalendarWeekStartDay

• BusinessHoursStartTime

• BusinessHoursEndTime

• ActivityReminder

Lead Settings

The elements related to lead settings are as follows:

• ConvertOnlyEditableActivities

• OwnerFullNameRatingandSalesPersonarerequiredtoQualifyaLeadEnabled

• AutoUpdateSalesPersonFlag

Company Theme Settings

The elements related to theme settings are as follows:

• ThemeName

• TabletTheme

Company Data Visibility Settings

The elements related to data visibility settings are as follows:

• ManagerVisibilityEnabled

• ParentTeamInheritanceforContactEnabled

• ParentTeamInheritanceforOpportunityEnabled

• DefaultGroupAssignment

• BooksEnabled

• BookSelectorEnabled

• BookMergeEnabled

• DisplayParentBookHierarchy

Integration Settings

The elements related to integration settings are as follows:

• IntegrationEventEnabled

• WorkflowEnabled

• WebServicesR16CompatibilityMode

• IncludeWebLinkURLsInExport

• ImportBlankValueForMultiSelectPicklist

Company Security Settings

The elements related to company security are as follows:

• CompanyIdleTimeout

• CompanyIdleTimeoutWarning

• AuthenticationType

• ExternalIdentifierforSingleSignOn

• SignInPageforUseridOrPwdAuthentications

• SignInPageforSSOAuthentications

• CrossSiteRequestForgeryProtectionEnabled

• IFRAMEembeddingEnabled

• CrossSiteScriptingActionCode

• ConvertURLTextValuestoLinksFlag

The apdata:CurrentOrganization argument also contains the following elements related to the feature that restricts access to the system to specific IP address ranges:

• CompIPRestrictionEnabled. Whether IP Address Restrictions Enabled is set for your company.

• CompAllowedIP. The range of IP addresses that are allowed to access the system.

• ListOfRoleIPRestrictions. For each user role, the IP address restriction data is contained in the following child elements of <RoleIPRestrictions>:

  • RoleName. The name of the role.

  • RoleIPRestrictionEnabled. Whether IP Address Restrictions Enabled is set for the role.

  • RoleAllowedIP. The range of IP addresses for the role that are allowed to access the system.

For more information about the IP address restriction feature, see Oracle CRM On Demand Online Help.

Analytics Visibility Setting

The elements related to analytics visibility are as follows:

• ReportingSubjectArea

• HistoricalSubjectAreas

• RoleBasedCanReadAllRecords

Communications Settings

The elements related to communications settings are as follows:

• SendEmailonUserProfileUpdate

Additional Information

The elements related to additional information are as follows:

• LicensedUsers

• ActiveUsers

• InactiveUsers

• TrialEndDate

• ModifiedBy

The fields returned include the ActiveUsers and LicensedUsers fields. When administrators add, remove, inactivate, and activate users, or report on monthly user adoption, it is important to know the active and current license counts. The ActiveUsers and LicensedUsers fields allow you to use automated tools to report licensing information.

Geocoder Settings

The element related to geocoder is as follows:

• GeocoderEnabled

Arguments

The following table describes the arguments taken by the CurrentOrganizationRead method.

Table Arguments Taken by the CurrentOrganizationRead Method

Name	Description	Required	Default	I/O
apData:CurrentOrganization	The company profile data.	Required	Not applicable	Input/Output

Return Value of the Call

The company profile data is returned. See Oracle CRM On Demand Online Help for information about the company profile settings.

CustomHTMLHeadTagRead

Extracts custom HTML Head tag configuration data.

Usage

Use the CustomHTMLHeadTagRead method to extract custom HTML Head tag configuration data matching the input criteria. The Upload Client Side Extensions and Manage Custom HTML Head Tag privilege is required.

The HTML head additions are specified with the <HTMLHeadAdditions> element.

For more information about custom HTML head additions, see Oracle CRM On Demand Online Help.

Arguments

The following table describes the arguments taken by the CustomHTMLHeadTagRead method.

Table Arguments Taken by the CustomHTMLHeadTagRead Method

Name	Description	Required	Default	I/O
apQuery:CustomHTMLHeadTag	The custom HTML Head tag query criteria.	Yes	Not applicable	Input
apData:CustomHTMLHeadTag	The extracted custom HTML Head tag data.	Not applicable	Not applicable	Output

Return Value of the Call

The custom HTML Head tag data is returned.

CustomHTMLHeadTagUpsert

Updates existing custom HTML head additions or inserts new custom HTML head additions.

Usage

Use the CustomHTMLHeadTagUpsert method to insert or update HTML head additions data. The Upload Client Side Extensions and Manage Custom HTML Head Tag privilege is required.

The apdata:CustomHTMLHeadTag argument contains the following elements containing HTML head additions data: HTMLHeadAdditions.

Arguments

The following table describes the arguments taken by the CustomHTMLHeadTagUpsert method.

Table Arguments Taken by the CustomHTMLHeadTagUpsert Method

Name	Description	Required	Default	I/O
apData:CustomHTMLHeadTag	The HTML head additions data to be inserted or updated.	Yes	Not applicable	Input
Status	The status of the call.	Not applicable	Not applicable	Output

Return Value of the Call

The status is returned.

CustomRecordTypeRead

Extracts customized record type configuration data.

Usage

Use the CustomRecordTypeRead method to extract customized record type configuration data matching the input criteria.

The record type is specified with the <Name> child element of apQuery:CustomRecordType.

If the <IncludeAll> child element of apQuery:CustomRecordType specifies true, the method returns configuration data including preconfigured and customized data. If <IncludeAll> specifies false, or is not included in the request, the method returns customized configuration data only.

See CustomRecordTypeUpsert for information about the customized record type data specified in apData:ListOfCustomRecordType.

Arguments

The following table describes the arguments taken by the CustomRecordTypeRead method.

Table Arguments Taken by the CustomRecordTypeRead Method

Name	Description	Required	Default	I/O
apQuery:CustomRecordType	The customized record type query criteria.	Yes	Not applicable	Input
apData:ListOfCustomRecordType	The extracted customized record type data.	Not applicable	Not applicable	Output

Return Value of the Call

The customized record type data is returned.

CustomRecordTypeReadAll

Extracts all of the customized record type configuration data for a company.

Usage

Use the CustomRecordTypeReadAll method to read all of the customized record types.

If the input argument <IncludeAll> specifies true, the method returns all configuration data, including preconfigured and customized data. If <IncludeAll> specifies false, or is not included in the request, the method returns customized configuration data only.

The input argument <Version> specifies the release of Oracle CRM On Demand for which configuration data is returned. The default value is 21, and specified values up to and including 21 return configuration data applicable to Oracle CRM On Demand Release 21.

If the value specified is greater than 21, then all of the configuration data up to the release specified is returned. For example, if a value of 22 is specified, then all of the configuration data in Release 21 plus the new data in Release 22 is returned.

See CustomRecordTypeUpsert for information about the customized record type data specified in apData:ListOfCustomRecordType.

Arguments

The following table describes the arguments taken by the CustomRecordTypeReadAll method.

Table Arguments Taken by the CustomRecordTypeReadAll Method

Name	Description	Required	Default	I/O
IncludeAll	If true, extracts all configuration data and not just customized configuration data.	No	false	Input
Version	Specifies the release of Oracle CRM On Demand for which configuration data is returned.	No	21	Input
apData:ListOfCustomRecordType	The extracted data for all customized record types.	Not applicable	Not applicable	Output

Return Value of the Call

The customized record types are returned.

CustomRecordTypeUpsert

Updates an existing customized record type or inserts a new customized record type.

Usage

Use the CustomRecordTypeUpsert method to insert or update customized record type data.

The apdata:CustomRecordType argument contains the following elements containing customized record type data:

• Name. The object name of the record type.

• SingularName. The singular display name used in the UI.

• PluralName. The plural display name used in the UI.

• ShortName. The short display name used in the UI.

  Note: SingularName, PluralName and ShortName are language independent names. If these names are present in the input, the behavior is similar to Mark for Translation being selected in the UI. These elements are not required for customizing language dependent singular/plural/short names for an object, as they are handled by ListOfCustomRecordTypeTranslation.

• SupportDisplayImage. Whether an image is displayed on the record type’s Detail page. This corresponds to the Display Image check box in the UI.

• IconName. The file name of the classic theme icon for the record type.

• ModernIconName. The file name of the modern theme icon for the record type.

• AccessObjName. The name of the object as used in access profiles (this is read-only).

• CustomizePreviousOwnerChannel. The circumstances in which the previous owner of a record is retained in the team when the owner of a record that is shared by a team is changed. This element is applicable only for record types for which sharing of records is supported. The value can be one of the following:

  • Never Retain Owner. This is the default value. The previous owner of the record will not be retained in the team.

  • Always Retain Owner. The previous owner of the record will be retained in the team, except when the owner is changed using the assignment manager.

  • All Interactive Operations. The previous owner of the record will be retained in the team, except when the owner is changed using the Import Assistant, the assignment manager, the mass update feature, or Web services.

• CustomizePreviousOwnerAccessProfileId. The ID of the access profile for the previous owner of a shared record.

• CustomizePreviousOwnerAccessProfile. The name of the access profile for the previous owner of a shared record.

• ListOfCustomRecordTypeTranslation. The object display names in the languages activated for your company:

  • LanguageCode. The three-letter language code for the language.

  • SingularName. The singular name of the customized record type in the language identified by the language code.

  • PluralName. The plural name of the customized record type in the language identified by the language code.

  • ShortName. The short name of the customized record type in the language identified by the language code.

See Oracle Migration Tool On Demand Guide for reference tables about the following:

• Mappings of three-letter language codes to languages.

• Mappings of icon filenames to icons for record types in the Oracle CRM On Demand user interface.

Note: Custom icons may be available for use as modern theme icons, and in this case the filenames used are system-generated. These filenames, for the Icon Type of Mini Icon, are displayed in the Icon Set Detail page in the Oracle CRM On Demand UI. For more information about custom icon sets, see Oracle CRM On Demand Online Help.

Arguments

The following table describes the arguments taken by the CustomRecordTypeUpsert method.

Table Arguments Taken by the CustomRecordTypeUpsert Method

Name	Description	Required	Default	I/O
apData:CustomRecordType	The customized record type data to be inserted or updated.	Yes	Not applicable	Input
Status	The status of the call.	Not applicable	Not applicable	Output

Return Value of the Call

The status is returned.

CustomWebLinkRead

Extracts custom Web link configuration data.

Usage

Use the CustomWebLinkRead method to extract custom Web link configuration data for an object.

The object is specified with the <ObjectName> child element of apQuery:WebLinkSet.

See CustomWebLinkUpsert for information about the custom Web link data specified in apData:WebLinkSet.

Note: Internally, concatenated fields are custom Web links, however you cannot use the CustomWebLinkRead method to read concatenated field data.

Arguments

The following table describes the arguments taken by the CustomWebLinkRead method.

.

Table Arguments Taken by the CustomWebLinkRead Method

Name	Description	Required	Default	I/O
apQuery:WebLinkSet	The custom Web link query criteria.	Yes	Not applicable	Input
apData:ListOfWebLinkSet	The extracted custom Web link data.	Not applicable	Not applicable	Output

Return Value of the Call

The custom Web link is returned.

CustomWebLinkReadAll

Extracts all of the custom Web link configuration data for a company.

Usage

Use the CustomWebLinkReadAll method to read all of the custom Web links.

There is no input argument; the method simply returns all of the custom Web link data.

See CustomWebLinkUpsert for information about the custom Web link data specified in apData:WebLinkSet.

Note: Internally, concatenated fields are custom Web links, however you cannot use the CustomWebLinkReadAll method to read concatenated field data.

Arguments

The following table describes the arguments taken by the CustomWebLinkReadAll method.

Table Arguments Taken by the CustomWebLinkReadAll Method

Name	Description	Required	Default	I/O
apData:ListOfWebLinkSet	The extracted data for all custom Web links.	Not applicable	Not applicable	Output

Return Value of the Call

The custom Web links are returned.

CustomWebLinkUpsert

Updates custom Web link data or inserts new custom Web link data for an object.

Usage

Use the CustomWebLinkUpsert method to insert custom Web link or update existing custom Web link data for an object.

The object is specified with the <ObjectName> child element of apData:WebLinkSet.

The apdata:WebLinkSet argument contains the following elements containing custom Web link data:

• Name. The name of the custom Web link field. When performing an insert operation, this name is used as the display name, if a display name is not provided in the <WebLinkTranslation> element.

• IntegrationTag. The field’s integration tag name.

• DisplayText. The label for the hyperlink of the custom Web link.

• WebLinkTarget. The behavior when a user clicks the hyperlink. Open in Current window, Open in Custom Tab, or Open in New window.

• TargetCustomWebTab. The required custom Web tab, if Open in Custom Tab is specified for WebLinkTarget.

• RefreshParentWindow. Whether the parent window is refreshed after a new window is opened. Only applicable if Open in New window is specified for WebLinkTarget.

• DisplayOptions. A character indicating the pages where the custom Web link is displayed: D for Detail Page, E for Edit Page, or B for Both.

• ActiveLinkCondition. The condition that controls whether the custom Web link is active on the Detail and Edit pages.

• DisplayLinkCondition. The condition that controls whether the custom Web link is visible on the Detail and Edit pages.

• Type. The type of custom Web link, which can be Dashboard, Report, or URL.

• URL. The URL that is invoked when the user clicks the custom Web link.

• ReportType. Settings for a Report Web link:

  • ReportPath. The path to the report, which must be located under Shared Folders (required).

  • ReportParameters. The filters that will be applied to the report at runtime. For example: <data:ReportParameters>P0=1&amp;P1=eq&amp;P2="Account"."Account ID"&amp;P3=%%%Row_Id%%%</data:ReportParameters>. The filter syntax is validated when you insert or update. For more information about specifying parameters, see Oracle CRM On Demand Online Help.

  • ReportPrompts. Whether any prompts that are configured for the report are displayed at runtime. Corresponds to the Display Report Prompts check box in the UI.

    Note: If the <ReportPrompts> element is set to true, then any filters that are specified in the <ReportParameters> element are ignored at runtime, even if no prompts are defined for the analysis.

  • RefreshLink. Whether the Refresh link that allows users to refresh the report is available at runtime.

  • PrintLink. Whether the Print link that allows users to print the report is available at runtime.

  • ExportLink. Whether the Export link that allows users to download the report is available at runtime.

• DashboardType. Settings for a Dashboard Web link:

  • DashboardPath. The path to the dashboard (required). The dashboard must be located directly in the Dashboards folder under Shared Folders and not at a deeper level. This validation is enforced only in the UI and not via Web service Upsert calls.

  • DashboardParameters. The filters that will be applied to the dashboard at runtime. For example: <data:DashboardParameters>P0=1&amp;P1=eq&amp;P2="Account"."Account ID"&amp;P3=%%%Row_Id%%%</data:DashboardParameters>. The filter syntax is validated when you insert or update. For more information about specifying parameters, see Oracle CRM On Demand Online Help.

• ListOfWebLinkTranslations. The display names in the languages activated for your company:

  • DisplayName. The display name of the custom Web link in the language identified by the language code.

  • DisplayText. The label for the hyperlink, in the language identified by the language code.

  • LangCode. The three-letter language code for the language.

See Oracle Migration Tool On Demand Guide for reference tables about the following:

• Mappings of three-letter language codes to languages.

• Mappings of object names to the display names for the objects in the Oracle CRM On Demand user interface.

For more information about custom Web links, see Oracle CRM On Demand Online Help.

Note: Internally, concatenated fields are custom Web links, however you cannot use the CustomWebLinkUpsert method to update or insert concatenated field data.

Arguments

The following table describes the arguments taken by the CustomWebLinkUpsert method.

Table Arguments Taken by the CustomWebLinkUpsert Method

Name	Description	Required	Default	I/O
apData:WebLinkSet	The custom Web link data to be inserted or updated.	Yes	Not applicable	Input
Status	The status of the call.	Not applicable	Not applicable	Output

Return Value of the Call

The status is returned.

CustomWebTabDelete

Deletes a custom Web tab.

Usage

Use the CustomWebTabDelete method to delete a custom Web tab matching the input criteria.

The custom Web tab is specified with the <DisplayName> child element of apQuery:CustomWebTab.

See CustomWebTabUpsert for information about the custom Web tab data specified in apData:CustomWebTab.

Arguments

The following table describes the arguments taken by the CustomWebTabDelete method.

Table Arguments Taken by the CustomWebTabDelete Method

Name	Description	Required	Default	I/O
apQuery:CustomWebTab	The custom Web tab query criteria.	Yes	Not applicable	Input
Status	The status of the call.	Not applicable	Not applicable	Output

Return Value of the Call

The status of the call is returned.

CustomWebTabRead

Extracts custom Web tab configuration data.

Usage

Use the CustomWebTabRead method to extract custom Web tab configuration data matching the input criteria. The Manage Roles and Access privilege is required.

The custom Web tab is specified with the <DisplayName> child element of apQuery:CustomWebTab.

See CustomWebTabUpsert for information about the custom Web tab data specified in apData:CustomWebTab.

Arguments

The following table describes the arguments taken by the CustomWebTabRead method.

Table Arguments Taken by the CustomWebTabRead Method

Name	Description	Required	Default	I/O
apQuery:CustomWebTab	The custom Web tab query criteria.	Yes	Not applicable	Input
apData:CustomWebTab	The extracted custom Web tab data.	Not applicable	Not applicable	Output

Return Value of the Call

The custom Web tab is returned.

CustomWebTabReadAll

Extracts all of the custom Web tab configuration data for a company.

Usage

Use the CustomWebTabReadAll method to read all of the custom Web tabs.

There is no input argument; the method simply returns all of the custom Web tab data.

See CustomWebTabUpsert for information about the custom Web tab data specified in apData:CustomWebTab.

Arguments

The following table describes the arguments taken by the CustomWebTabReadAll method.

Table Arguments Taken by the CustomWebTabReadAll Method

Name	Description	Required	Default	I/O
apData:ListOfCustomWebTab	The extracted data for all custom Web tabs.	Not applicable	Not applicable	Output

Return Value of the Call

The custom Web tabs are returned.

CustomWebTabUpsert

Updates an existing custom Web tab or inserts a new custom Web tab.

Usage

Use the CustomWebTabUpsert method to insert a custom Web tab or update an existing custom Web tab.

The apdata:CustomWebTab argument contains the following elements containing custom Web tab data:

• DisplayName. The name of the custom Web tab (required). When performing an insert operation, this name is used as the display name, if a display name is not provided in the <CustomWebTabTranslation> element.

• Description. A description of the custom Web tab.

• Type. The type of custom Web Tab, which can be Dashboard, HTML, Report or URL.

• HTMLHeadAdditions. The HTML to be added within the <head> element of the custom Web tab. (For type HTML only).

• WebTabHTML. The HTML to be added within the <body> element of the custom Web tab. (For type HTML only).

• Url. The URL for the custom Web tab.

• FrameHeight. The frame height defined for the custom Web tab.

• FrameWidth. The frame width defined for the custom Web tab.

• IconName. The filename of the icon used for the custom Web tab.

• ReportType. Settings for a Report Web tab:

  • ReportPath. The path to the report, which must be located under Shared Folders (required).

  • ReportParameters. The filters that will be applied to the report at runtime. For example: <data:ReportParameters>P0=1&amp;P1=eq&amp;P2="Account"."Account ID"&amp;P3=%%%Row_Id%%%</data:ReportParameters>. The filter syntax is validated when you insert or update. For more information about specifying parameters, see Oracle CRM On Demand Online Help.

  • ReportPrompts. Whether any prompts that are configured for the report are displayed at runtime. Corresponds to the Display Report Prompts check box in the UI.

    Note: If the <ReportPrompts> element is set to true, then any filters that are specified in the <ReportParameters> element are ignored at runtime, even if no prompts are defined for the analysis.

  • RefreshLink. Whether the Refresh link that allows users to refresh the report is available at runtime.

  • PrintLink. Whether the Print link that allows users to print the report is available at runtime.

  • ExportLink. Whether the Export link that allows users to download the report is available at runtime.

• DashboardType. Settings for a Dashboard Web tab:

  • DashboardPath. The path to the dashboard (required). The dashboard must be located directly in the Dashboards folder under Shared Folders and not at a deeper level. This validation is enforced only in the UI and not via Web service Upsert calls.

  • DashboardParameters. The filters that will be applied to the dashboard at runtime. For example: <data:DashboardParameters>P0=1&amp;P1=eq&amp;P2="Account"."Account ID"&amp;P3=%%%Row_Id%%%</data:DashboardParameters>. The filter syntax is validated when you insert or update. For more information about specifying parameters, see Oracle CRM On Demand Online Help.

• ListOfCustomWebTabTranslation. The display names in the languages activated for your company:

  • LanguageCode. The three-letter language code for the language.

  • DisplayName. The display name of the custom Web tab in the language identified by the language code.

See Oracle Migration Tool On Demand Guide for reference tables about the following:

• Mappings of three-letter language codes to languages.

Arguments

The following table describes the arguments taken by the CustomWebTabUpsert method.

Table Arguments Taken by the CustomWebTabUpsert Method

Name	Description	Required	Default	I/O
apData:CustomWebTab	The custom Web tab data to be inserted or updated.	Yes	Not applicable	Input
Status	The status of the call.	Not applicable	Not applicable	Output

Return Value of the Call

The status is returned.

DetailPageCustomWebAppletRead

Extracts detail page Web applet configuration data.

Usage

Use the DetailPageCustomWebAppletRead method to read configuration data for a detail page Web applet.

The record type and Web applet are specified with the <ObjectName> and <DisplayName> child elements of apQuery:DetailPageCustomWebApplet.

See DetailPageCustomWebAppletUpsert for information about the data specified in apData:ListOfDetailPageCustomWebApplet.

Arguments

The following table describes the arguments taken by the DetailPageCustomWebAppletRead method.

Table Arguments Taken by the DetailPageCustomWebAppletRead Method

Name	Description	Required	Default	I/O
apQuery:DetailPageCustomWebApplet	The Web applet query criteria.	Yes	Not applicable	Input
apData:ListOfDetailPageCustomWebApplet	The extracted data for the Web applet.	Not applicable	Not applicable	Output

Return Value of the Call

The Web applet data is returned.

DetailPageCustomWebAppletReadAll

Extracts all of the detail page Web applet configuration data for a company.

Usage

Use the DetailPageCustomWebAppletReadAll method to read all of the detail page Web applets.

The input argument <Version> specifies the release of Oracle CRM On Demand for which configuration data is returned. The default value is 27, and specified values up to and including 27 return configuration data applicable to Oracle CRM On Demand Release 27.

If the value specified is greater than 27, then all of the configuration data up to the release specified is returned. For example, if a value of 28 is specified, then all of the configuration data in Release 27 plus the newer data up to Release 28 is returned.

See DetailPageCustomWebAppletUpsert for information about the data specified in apData:ListOfDetailPageCustomWebApplet.

Arguments

The following table describes the arguments taken by the DetailPageCustomWebAppletReadAll method.

Table Arguments Taken by the DetailPageCustomWebAppletReadAll Method

Name	Description	Required	Default	I/O
Version	Specifies the release of Oracle CRM On Demand for which configuration data is returned.	No	27	Input
apData:ListOfDetailPageCustomWebApplet	The extracted data for all detail page Web applets.	Not applicable	Not applicable	Output

Return Value of the Call

The detail page Web applets are returned.

DetailPageCustomWebAppletUpsert

Updates an existing detail page Web applet or inserts a new Web applet.

Usage

Use the DetailPageCustomWebAppletUpsert method to insert or update an existing detail page Web applet.

If the Enable Language Translation Support for Web Applets check box is selected in the company profile, then you can use the <LanguageCode> and <DisplayName> child elements of the <Translation> element to insert or update translations of the Web applet display name in each language for your company.

The apData:DetailPageCustomWebApplet argument contains the following elements containing detail page Web applet data:

• ObjectName. The record type. Required.

• DisplayName. The name of the Web applet. Required.

• DisplayNameCurrentUserLang. The name of the Web applet in the language of the currently logged-in user.

• Description. A description for the Web applet.

• Height. The height of the applet in pixels.

• FeedType. Settings for an RSS feed applet:

  • URL. The URL that is invoked when the user clicks the hyperlink.

  • OverrideURLFlag. Whether or not the user can override the URL.

  • TargetWindow. The window in which the Web applet opens: Current Window or New Window.

• HTMLType. Settings for an HTML Web applet:

  • HTMLHeader. HTML code used in an <iframe> element within the HTML header of the page to which you add the Web applet.

  • HTMLBody. HTML code used in an <iframe> element within the HTML body of the page to which you add the Web applet.

  • AlwaysRun. Whether the Web applet will be executed if the applet is minimized.

• URLType. Settings for a URL Web applet:

  • URL. The URL that is invoked when the user clicks the hyperlink.

  • AlwaysRun. Whether the Web applet will be executed if the applet is minimized.

• ReportType. Settings for a Report Web applet:

  • ReportPath. The path to the report, which must be located under Shared Folders (required).

  • ReportParameters. The filters that will be applied to the report at runtime. For example: <data:ReportParameters>P0=1&amp;P1=eq&amp;P2="Account"."Account ID"&amp;P3=%%%Row_Id%%%</data:ReportParameters>. The filter syntax is validated when you insert or update. For more information about specifying parameters, see Oracle CRM On Demand Online Help.

  • ReportPrompts. Whether any prompts that are configured for the report are displayed at runtime. Corresponds to the Display Report Prompts check box in the UI.

    Note: If the <ReportPrompts> element is set to true, then any filters that are specified in the <ReportParameters> element are ignored at runtime, even if no prompts are defined for the analysis.

  • RefreshLink. Whether the Refresh link that allows users to refresh the report is available at runtime.

  • PrintLink. Whether the Print link that allows users to print the report is available at runtime.

  • ExportLink. Whether the Export link that allows users to download the report is available at runtime.

  • AlwaysRun. Whether the Web applet will be executed if the applet is minimized.

• DashboardType. Settings for a Dashboard Web applet:

  • DashboardPath. The path to the dashboard (required). The dashboard must be located directly in the Dashboards folder under Shared Folders and not at a deeper level. This validation is enforced only in the UI and not via Web service Upsert calls.

  • DashboardParameters. The filters that will be applied to the dashboard at runtime. For example: <data:DashboardParameters>P0=1&amp;P1=eq&amp;P2="Account"."Account ID"&amp;P3=%%%Row_Id%%%</data:DashboardParameters>. The filter syntax is validated when you insert or update. For more information about specifying parameters, see Oracle CRM On Demand Online Help.

  • AlwaysRun. Whether the Web applet will be executed if the applet is minimized.

• ModernIconName. The file name of the modern theme icon for the Web applet.

• ListOfTranslation. The display names in the languages activated for your company:

  • LanguageCode. The three-letter language code for the language.

  • DisplayName. The display name of the custom Web applet in the language identified by the language code.

See Oracle Migration Tool On Demand Guide for reference tables about the following:

• Mappings of three-letter language codes to languages.

See Oracle CRM On Demand Online Help for more information about creating Web applets.

Arguments

The following table describes the arguments taken by the DetailPageCustomWebAppletUpsert method.

Table Arguments Taken by the DetailPageCustomWebAppletUpsert Method

Name	Description	Required	Default	I/O
apData:DetailPageCustomWebApplet	The Web applet data to be inserted or updated.	Yes	Not applicable	Input
Status	The status of the call.	Not applicable	Not applicable	Output

Return Value of the Call

The status is returned.

DynamicLayoutRead

Extracts all of the configuration data for a dynamic page layout for an object.

Usage

Use the DynamicLayoutRead method to read the dynamic page layout data for an object.

The object is specified with the <ObjectName> child element of <apQuery:DynamicLayoutSet>.

See DynamicLayoutUpsert for information about the dynamic page layout data specified in apData:ListOfDynamicLayoutSet.

Arguments

The following table describes the arguments taken by the DynamicLayoutRead method.

Table Arguments Taken by the DynamicLayoutRead Method

Name	Description	Required	Default	I/O
apQuery:DynamicLayoutSet	The dynamic page layout query criteria.	Yes	Not applicable	Input
apData:ListOfDynamicLayoutSet	The extracted dynamic page layout data.	Not applicable	Not applicable	Output

Return Value of the Call

The dynamic page layout is returned.

DynamicLayoutReadAll

Extracts all of the dynamic page layout configuration data for a company.

Usage

Use the DynamicLayoutReadAll method to read all of the dynamic page layout data.

There is no input argument; the method simply returns all of the dynamic page layout data for all record types.

See DynamicLayoutUpsert for information about the dynamic page layout data specified in apData:ListOfDynamicLayoutSet.

Arguments

The following table describes the arguments taken by the DynamicLayoutReadAll method.

Table Arguments Taken by the DynamicLayoutReadAll Method

Name	Description	Required	Default	I/O
apData:ListOfDynamicLayoutSet	The extracted dynamic page layout data.	Not applicable	Not applicable	Output

Return Value of the Call

The dynamic page layouts are returned.

DynamicLayoutUpsert

Updates existing dynamic page layout data or inserts new dynamic page layout data.

Usage

Use the DynamicLayoutUpsert method to insert or update dynamic page layout data.

The apdata:DynamicLayoutSet argument contains the following elements containing dynamic page layout data:

• ObjectName. The name of the object.

• DrivingPicklist. The driving picklist.

• ListOfDynamicLayouts. Contains all of the dynamic page layout data. The data for a dynamic page layout is contained in the following child elements of <DynamicLayout>:

  • Name. The name of the dynamic page layout.

  • DefaultLayout. The default page layout with which driving picklist values are associated.

  • Description. A description of the dynamic page layout.

  • ListOfPicklistValueMapping. The mappings of driving picklist values to page layouts.

    • Value. A driving picklist value.

    • AssignedLayout. The page layout that is displayed when the driving picklist value is selected.

See Oracle Migration Tool On Demand Guide for reference tables about the mappings of object names to the display names for the objects in the Oracle CRM On Demand user interface.

Arguments

The following table describes the arguments taken by the DynamicLayoutUpsert method.

Table Arguments Taken by the DynamicLayoutUpsert Method

Name	Description	Required	Default	I/O
apData:DynamicLayoutSet	The dynamic page layout data to be inserted or updated.	Yes	Not applicable	Input
Status	The status of the call.	Not applicable	Not applicable	Output

Return Value of the Call

The status is returned.

EnableModificationTrackingRead

Extracts modification tracking configuration data.

Usage

Use the EnableModificationTrackingRead method to extract modification tracking configuration data for an object. The Manage Modification Tracking privilege is required.

The object is specified with the <Object> child element of apQuery:EnableModificationTracking. The <Enabled> child element of the returned apData:EnableModificationTracking indicates whether the object is enabled for modification tracking.

Arguments

The following table describes the arguments taken by the EnableModificationTrackingRead method.

Table Arguments Taken by the EnableModificationTrackingRead Method

Name	Description	Required	Default	I/O
apQuery:EnableModificationTracking	The modification tracking query criteria.	Yes	Not applicable	Input
apData:ListOfEnableModificationTracking	The extracted modification tracking data.	Not applicable	Not applicable	Output

Return Value of the Call

The modification tracking data is returned.

EnableModificationTrackingReadAll

Extracts all of the modification tracking configuration data for a company.

Usage

Use the EnableModificationTrackingReadAll method to read all of the modification tracking data. The Manage Modification Tracking privilege is required.

The <Enabled> child element of the returned apData:ListofEnableModificationTracking indicates whether each object is enabled for modification tracking.

Arguments

The following table describes the arguments taken by the EnableModificationTrackingReadAll method.

Table Arguments Taken by the EnableModificationTrackingReadAll Method

Name	Description	Required	Default	I/O
apData:ListOfEnableModificationTracking	The extracted modification tracking data.	Not applicable	Not applicable	Output

Return Value of the Call

The modification tracking data is returned.

EnableModificationTrackingUpsert

Updates existing modification tracking data or inserts modification tracking configuration data for an object.

Usage

Use the EnableModificationTrackingUpsert method to enable or disable modification tracking for objects. The Manage Modification Tracking and Manage Roles and Access privileges are required.

The object is specified with the <Object> child element of apData:EnableModificationTracking, and the <Enabled> element specifies whether the object is enabled (true) or disabled (false) for modification tracking.

See Oracle Migration Tool On Demand Guide for reference tables about the following:

• Mappings of object names to the display names for the objects in the Oracle CRM On Demand user interface.

For more information about modification tracking setup, see Oracle CRM On Demand Online Help.

Arguments

The following table describes the arguments taken by the EnableModificationTrackingUpsert method.

Table Arguments Taken by the EnableModificationTrackingUpsert Method

Name	Description	Required	Default	I/O
apData:ListOfEnableModificationTracking	The modification tracking data to be inserted or updated.	Yes	Not applicable	Input
Status	The status of the call.	Not applicable	Not applicable	Output

Return Value of the Call

The status is returned.

FieldAuditSetupRead

Extracts field audit configuration data.

Usage

Use the FieldAuditSetupRead method to extract field audit configuration data for an object. The Administer Field Audit privilege is required.

The object is specified with the <ObjectName> child element of apQuery:FieldSet.

See FieldAuditSetupUpsert for information about the field audit data specified in apData:FieldSet.

Arguments

The following table describes the arguments taken by the FieldAuditSetupRead method.

Table Arguments Taken by the FieldAuditSetupRead Method

Name	Description	Required	Default	I/O
apQuery:FieldSet	The field audit query criteria.	Yes	Not applicable	Input
apData:ListOfFieldSet	The extracted field audit data.	Not applicable	Not applicable	Output

Return Value of the Call

The field audit data is returned.

FieldAuditSetupReadAll

Extracts all of the field audit configuration data for a company.

Usage

Use the FieldAuditSetupReadAll method to read all of the field audit data. The Administer Field Audit privilege is required.

See FieldAuditSetupUpsert for information about the field audit data specified in apData:FieldSet.

Arguments

The following table describes the arguments taken by the FieldAuditSetupReadAll method.

Table Arguments Taken by the FieldAuditSetupReadAll Method

Name	Description	Required	Default	I/O
apData:ListOfFieldSet	The extracted field audit data.	Not applicable	Not applicable	Output

Return Value of the Call

The field audit data is returned.

FieldAuditSetupUpsert

Updates existing field audit data or inserts field audit configuration data for an object.

Usage

Use the FieldAuditSetupUpsert method to insert field audit data or update existing field audit data for an object. The Administer Field Audit privilege is required.

The object is specified with the <ObjectName> child element of apData:FieldSet.

The apdata:FieldSet argument contains the following elements containing field audit data:

• ObjectName. The system name of the object.

• AuditRecordCreation. Whether the creation of records is tracked.

• AuditRecordDeletionOrRestore. Whether the deletion or restoration of records is tracked.

• ListOfFields. The list of available fields for the object.

  • Name. The system name of the field.

  • IsAudited. Whether the field is audited.

See Oracle Migration Tool On Demand Guide for reference tables about the following:

• Mappings of object names to the display names for the objects in the Oracle CRM On Demand user interface.

For more information about field audit setup, see Oracle CRM On Demand Online Help.

Arguments

The following table describes the arguments taken by the FieldAuditSetupUpsert method.

Table Arguments Taken by the FieldAuditSetupUpsert Method

Name	Description	Required	Default	I/O
apData:FieldSet	The field audit data to be inserted or updated.	Yes	Not applicable	Input
Status	The status of the call.	Not applicable	Not applicable	Output

Return Value of the Call

The status is returned.

FieldManagementCreate

Creates field management configuration data.

Usage

Use the FieldManagementCreate method to create custom fields.

The object is specified with the <ObjectName> child element of apData:CustomField. The field management data for the object is contained in elements similar to those of the apData:FieldManagement argument used by the FieldManagementUpsert method, see FieldManagementUpsert.

By specifying true for the <Optimized> element in the apData:CustomField argument, you can create an optimized custom field.

Several record types do not support regular custom fields of particular types, but do support optimized custom fields. These record types include:

• Sales Assessment Template

• Product Indication

• Account Partner

• Opportunity Partner

• Opportunity Team

• Account Team

• Lead Team

• Business Plan Team

• Service Request Team

For example, Sales Assessment Template does not support regular custom Text (Long) fields but it does support optimized custom Text (Long) fields. For Web service requests to create such fields, you must explicitly specify true for <Optimized>, otherwise an error is generated. In the UI, the Optimized check box will be selected and disabled for such record types. As you cannot deselect the Optimized check box, you are forced to create the field as optimized.

Arguments

The following table describes the arguments taken by the FieldManagementCreate method.

Table Arguments Taken by the FieldManagementCreate Method

Name	Description	Required	Default	I/O
apData:CustomField	The field management query criteria.	Yes	Not applicable	Input
Status	The status of the call.	Not applicable	Not applicable	Output

Return Value of the Call

The status of the call is returned.

FieldManagementRead

Extracts field management configuration data.

Usage

Use the FieldManagementRead method to extract field management configuration data for an object.

The object is specified with the <ObjectName> child element of apQuery:FieldSet.

If the <IncludeAll> child element of apQuery:FieldSet specifies true, the method returns configuration data including preconfigured and customized data. If <IncludeAll> specifies false, or is not included in the request, the method returns customized configuration data only.

Regardless of whether only customized data is returned, or preconfigured and customized data, translated data for all languages enabled by the company are included in the output.

The <sortSpecification> child element of apQuery:FieldSet allows you to sort the field management data by field name. The format for the parameter is a comma-separated list of up to three fields in the format:

field name sort order

where:

• field name can be CreatedDate, ModifiedDate, or Name.

• sort order can be asc for sorting in ascending order, or desc for sorting in decending order. The default value is asc.

See FieldManagementUpsert for information about the field management data specified in apData:FieldSet.

By default, FieldManagementRead only extracts field definitions for fields that have been created by the user, or preconfigured fields that have been modified. Unmodified preconfigured fields are bypassed because they exist on all company instances. See the information in this section about <IncludeAll> for details on how to include all fields, including preconfigured fields, in the SOAP response.

Note: Configuration data is for returned for the Call Activity History record type even though it is not exposed in the Oracle CRM On Demand UI.

Arguments

The following table describes the arguments taken by the FieldManagementRead method.

Table Arguments Taken by the FieldManagementRead Method

Name	Description	Required	Default	I/O
apQuery:FieldSet	The field management query criteria.	Yes	Not applicable	Input
apData:ListOfFieldSet	The extracted field management data.	Not applicable	Not applicable	Output

Return Value of the Call

The field management data is returned.

FieldManagementReadAll

Extracts all of the field management configuration data for a company.

Usage

Use the FieldManagementReadAll method to read all of the field management data.

If the input argument <IncludeAll> specifies true, the method returns all configuration data, including preconfigured and customized data. If <IncludeAll> specifies false, or is not included in the request, the method returns customized configuration data only.

When the input argument <IncludeAll> and DefaultAddressField element of apData:FieldSet specify true, the method returns all preconfigured and customized field data, including default address fields.

The input argument <sortSpecification> allows you to sort the field management data by field name. The format for the parameter is a comma-separated list of up to three fields in the format:

field name sort order

where:

• field name can be CreatedDate, ModifiedDate, or Name.

• sort order can be asc for sorting in ascending order, or desc for sorting in descending order. The default value is asc.

The sorted data is only returned when the input argument <Version> has the value of 39 or higher.

The input argument <Version> specifies the release of Oracle CRM On Demand for which configuration data is returned. The default value is 23, and specified values up to and including 23 return configuration data applicable to Oracle CRM On Demand Release 23.

If the value specified is greater than 23, then all of the configuration data up to the release specified is returned. For example, if a value of 25 is specified, then all of the configuration data in Release 23 plus the newer data up to Release 25 is returned.Regardless of whether only customized data is returned, or preconfigured and customized data, translated data for all languages enabled by the company are included in the output.

See FieldManagementUpsert for information about the field management data specified in apData:FieldSet.

Note: Configuration data is returned for the Call Activity History record type although the record type is not supported for insert or update operations. The Call Activity History record type does not have a tab in the Oracle CRM On Demand UI, but it is available for field management in the UI.

Arguments

The following table describes the arguments taken by the FieldManagementReadAll method.

Table Arguments Taken by the FieldManagementReadAll Method

Name	Description	Required	Default	I/O
IncludeAll	If true, extracts all configuration data and not just customized configuration data.	No	false	Input
Version	Specifies the release of Oracle CRM On Demand for which configuration data is returned.	No	23	Input
sortSpecification	A sort specification that allows sorting by field name, created date and modified date.	No	Not applicable	Input
apData:ListOfFieldSet	The extracted field management data.	Not applicable	Not applicable	Output

Return Value of the Call

The field management data is returned.

FieldManagementUpsert

Updates existing field management data or inserts field management data for an object.

Usage

Use the FieldManagementUpsert method to insert field management data or update existing field management data for an object.

The object is specified with the <ObjectName> child element of apData:FieldSet.

The apdata:FieldSet argument contains the following elements containing field management data:

• Name. The system name of the field.

• DisplayName. The name of the field used in the UI. When performing an insert operation, this name is used as the display name, if a display name is not provided in the <FieldManagementTranslation> element.

• FieldType. The type of field.

• IntegrationTag. The field's custom integration tag name. This tag can be modified by the user.

• GenericIntegrationTag. The field's default integration tag name assigned by Oracle CRM On Demand. This tag cannot be modified by the user. The default integration tag name has the format fieldtypeDisplay_Name. For example, stMy_Custom_Field would be assigned to a custom field of type Text (Short) with the display name of My Custom Field.

  Note: For noncustom fields, the <GenericIntegrationTag> and <IntegrationTag> values are the same.

• Required. Whether the field is a required field (true), or is not a required field (false).

• RequiredCondition. An expression used to determine whether the field is required. If the <Required> element is set to true, any value in the <RequiredCondition> element produces an error message. For more information about conditionally-required fields, see Oracle CRM On Demand Online Help.

• ReadOnly. Whether the field is a read-only field (true), or is not a read-only field (false).

• Optimized. Whether the field is an optimized custom field. You cannot update this value.

• DefaultValue. The default value of the field.

• FieldValidation. The expression for the field validation rules for the field.

• PostDefault. Whether the field is prepopulated with the default value when a user creates a new record and the record is saved.

• DenormalizedControl. This maps to the Related Information check box in field management.

For Custom Object record types and certain other record types, you can create custom related information fields. For these record types, the following fields are available on the Field Edit page in the UI: Related Information, Related Record Type, and Related Field. These fields are used only for creating custom related information fields. Most of the other fields on the Field Edit page become read-only fields after you select the Related Information check box. For more information about custom related information fields, see Oracle CRM On Demand Online Help.

• DenormalizedAssociateControlName. This maps to the Related Record Type picklist in field management.

• DenormalizedControlName. This maps to the Related Field picklist in field management.

• ValidationErrorMsg. The custom error message displayed if the field fails field validation.

• TooltipFormat. The format of the tooltip text, which can be HTML or Plain Text.

• TooltipText. The tooltip text that is displayed for the field in the UI.

• Description. Additional information about the field.

• ListOfFieldTranslations. The field management data in the languages activated for your company:

  • LanguageCode. The three-letter language code for the language.

  • DisplayName. The display name of the field in the language identified by the language code.

  • ValidationErrorMsg. The custom validation error message in the language identified by the language code.

  • TooltipText. The tooltip text for the field in the language identified by the language code.

  • Description. The description of the field in the language identified by the language code.

• SharedPicklistFlag. Whether the field shares values with another picklist. Corresponds to the Enable Shared Picklist Values check box in the UI.

On certain record types, you can create a custom picklist field that takes its list of values from another picklist field on the same record type or on a different record type. The field from which the values are taken is referred to as the source field, and the field that shares the values from the source field is referred to as the destination field. For these record types, the following fields are available on the Field Edit page in the UI: Enable Shared Picklist Values, Shared Record Type, and Shared Field. For more information, see Oracle CRM On Demand Online Help.

• SharedPicklistObject. The record type of the source picklist. Corresponds to the Shared Record Type field in the UI.

• SharedPicklistControl. The field name of the source picklist. Corresponds to the Shared Field field in the UI.

See Oracle Migration Tool On Demand Guide for reference tables about the following:

• Mappings of three-letter language codes to languages.

• Mappings of object names to the display names for the objects in the Oracle CRM On Demand user interface.

For more information about field management, including field validation, see Oracle CRM On Demand Online Help.

Arguments

The following table describes the arguments taken by the FieldManagementUpsert method.

Table Arguments Taken by the FieldManagementUpsert Method

Name	Description	Required	Default	I/O
apData:FieldSet	The field management data to be inserted or updated.	Yes	Not applicable	Input
Status	The status of the call.	Not applicable	Not applicable	Output

Return Value of the Call

The status is returned.

HomepageLayoutReadAll

Extracts all of the homepage layout configuration data for a company.

Usage

Use the HomepageLayoutReadAll method to read all of the homepage layouts.

There is no input argument; the method simply returns all of the homepage layout data.

See HomepageLayoutUpsert for information about the homepage layout data specified in apData:ListOfHomepageLayout.

Arguments

The following table describes the arguments taken by the HomepageLayoutReadAll method.

Table Arguments Taken by the HomepageLayoutReadAll Method

Name	Description	Required	Default	I/O
apData:ListOfHomepageLayout	The extracted data for all homepage layouts.	Not applicable	Not applicable	Output

Return Value of the Call

The homepage layouts are returned.

HomepageLayoutUpsert

Updates an existing homepage layout or inserts a new homepage layout.

Usage

Use the HomepageLayoutUpsert method to insert or update an existing homepage layout.

The apdata:HomepageLayout argument contains the following elements containing homepage layout data:

• ObjectName. The name of the object.

• LayoutName. The name of the homepage layout.

• Description. A description of the homepage layout.

• ListOfAvailableSection. Contains all of the available sections for the homepage layout. The data for a particular section is contained in the following elements:

  • SectionName. An internal applet name that is associated with <SectionLayoutName> (read only).

  • SectionLayoutName. The name of a homepage section in the layout. This name is not the same as the display name of the section as it appears in the Homepage Layout wizard.

• ListOfSelectedSection. Contains all of the selected sections for the homepage layout. The data for a particular section is contained in the following elements:

  • SectionName. An internal applet name that is associated with <SectionLayoutName> (read only).

  • SectionLayoutName. The name of a homepage section in the layout. This name is not the same as the display name of the section as it appears in the Homepage Layout wizard.

  • Sequence. The sequence of the section within the lists of sections:

    • All even numbers, including 0 (zero) displays the specified section in the Left Side column, where 0 (zero) represents the first section, and so on.

    • All odd numbers display the section in the Right Side column, where a value of 1 represents the first section, and so on.

See Oracle Migration Tool On Demand Guide for reference tables about the following:

• Mappings of section layout names to section names used in the Oracle CRM On Demand user interface.

• Mappings of object names to the display names for the objects in the Oracle CRM On Demand user interface.

Arguments

The following table describes the arguments taken by the HomepageLayoutUpsert method.

Table Arguments Taken by the HomepageLayoutUpsert Method

Name	Description	Required	Default	I/O
apData:HomepageLayout	The homepage layout data to be inserted or updated.	Yes	Not applicable	Input
Status	The status of the call.	Not applicable	Not applicable	Output

Return Value of the Call

The status is returned.

HomepageCustomWebAppletRead

Extracts homepage Web applet configuration data.

Usage

Use the HomepageCustomWebAppletRead method to read configuration data for a homepage Web applet.

The record type and Web applet are specified with the <ObjectName> and <DisplayName> child elements of apQuery:HomePageCustomWebApplet.

See HomepageCustomWebAppletUpsert for information about the data specified in apData:ListOfHomePageCustomWebApplet.

The following table describes the arguments taken by the HomepageCustomWebAppletRead method.

Table Arguments Taken by the HomepageCustomWebAppletRead Method

Name	Description	Required	Default	I/O
apQuery:HomePageCustomWebApplet	The Web applet query criteria.	Yes	Not applicable	Input
apData:ListOfHomePageCustomWebApplet	The extracted data for the Web applet.	Not applicable	Not applicable	Output

Return Value of the Call

The Web applet data is returned.

HomepageCustomWebAppletReadAll

Extracts all of the homepage Web applet configuration data for a company.

Usage

Use the HomepageCustomWebAppletReadAll method to read all of the homepage Web applets.

The input argument <Version> specifies the release of Oracle CRM On Demand for which configuration data is returned. The default value is 27, and specified values up to and including 27 return configuration data applicable to Oracle CRM On Demand Release 27.

If the value specified is greater than 27, then all of the configuration data up to the release specified is returned. For example, if a value of 28 is specified, then all of the configuration data in Release 27 plus the newer data up to Release 28 is returned.

See HomepageCustomWebAppletUpsert for information about the data specified in apData:ListOfHomePageCustomWebApplet.

Arguments

The following table describes the arguments taken by the HomepageCustomWebAppletReadAll method.

Table Arguments Taken by the HomepageCustomWebAppletReadAll Method

Name	Description	Required	Default	I/O
Version	Specifies the release of Oracle CRM On Demand for which configuration data is returned.	No	27	Input
apData:ListOfHomePageCustomWebApplet	The extracted data for all homepage Web applets.	Not applicable	Not applicable	Output

Return Value of the Call

The homepage Web applets are returned.

HomepageCustomWebAppletUpsert

Updates an existing homepage Web applet or inserts a new Web applet.

Usage

Use the HomepageCustomWebAppletUpsert method to insert or update an existing homepage Web applet or a custom homepage report.

If the Enable Language Translation Support for Web Applets check box is selected in the company profile, then you can use the <LanguageCode> and <DisplayName> child elements of the <Translation> element to insert or update translations of the Web applet display name in each language for your company.

The apData:HomePageCustomWebApplet argument contains the following elements containing homepage Web applet data:

• ObjectName. The record type. Required.

• DisplayName. The name of the Web applet. Required.

• DisplayNameCurrentUserLang. The name of the Web applet in the language of the currently logged-in user.

• Description. A description for the Web applet.

• Width. The column width of the applet: 1 for Single, 2 for Double.

• Height. The height of the applet in pixels.

• FeedType. Settings for an RSS feed applet:

  • URL. The URL that is invoked when the user clicks the hyperlink.

  • OverrideURLFlag. Whether or not the user can override the URL.

  • TargetWindow. The window in which the Web applet opens: Current Window or New Window.

• HTMLType. Settings for an HTML Web applet:

  • HTMLHeader. HTML code used in an <iframe> element within the HTML header of the page to which you add the Web applet.

  • HTMLBody. HTML code used in an <iframe> element within the HTML body of the page to which you add the Web applet.

• URLType. Settings for a URL Web applet:

  • URL. The URL that is invoked when the user clicks the hyperlink.

• ReportType. Settings for a custom homepage report:

  • ReportPath. The path to the report, which must be located under Shared Folders (required).

  • ReportFlag. Whether the report will run automatically, and users will not have to click a link to update the report.

  • ReportPrompts. Whether any prompts that are configured for the report are displayed at runtime. Corresponds to the Display Report Prompts check box in the UI.

  • RefreshLink. Whether the Refresh link that allows users to refresh the report is available at runtime.

  • PrintLink. Whether the Print link that allows users to print the report is available at runtime.

  • ExportLink. Whether the Export link that allows users to download the report is available at runtime.

• WebAppletReportType. Settings for a Report Web applet.

  • ReportPath. The path to the report, which must be located under Shared Folders (required).

  • ReportParameters. The filters that will be applied to the report at runtime. For example: <data:ReportParameters>P0=1&amp;P1=eq&amp;P2="Account"."Account ID"&amp;P3=%%%Row_Id%%%</data:ReportParameters>. The filter syntax is validated when you insert or update. For more information about specifying parameters, see Oracle CRM On Demand Online Help.

  • ReportPrompts. Whether any prompts that are configured for the report are displayed at runtime. Corresponds to the Display Report Prompts check box in the UI.

    Note: If the <ReportPrompts> element is set to true, then any filters that are specified in the <ReportParameters> element are ignored at runtime, even if no prompts are defined for the analysis.

  • RefreshLink. Whether the Refresh link that allows users to refresh the report is available at runtime.

  • PrintLink. Whether the Print link that allows users to print the report is available at runtime.

  • ExportLink. Whether the Export link that allows users to download the report is available at runtime.

• DashboardType. Settings for a Dashboard Web applet.

  • DashboardPath. The path to the dashboard (required). The dashboard must be located directly in the Dashboards folder under Shared Folders and not at a deeper level. This validation is enforced only in the UI and not via Web service Upsert calls.

  • DashboardParameters. The filters that will be applied to the dashboard at runtime. For example: <data:DashboardParameters>P0=1&amp;P1=eq&amp;P2="Account"."Account ID"&amp;P3=%%%Row_Id%%%</data:DashboardParameters>. The filter syntax is validated when you insert or update. For more information about specifying parameters, see Oracle CRM On Demand Online Help.

• ListOfTranslation. The display names in the languages activated for your company:

  • LanguageCode. The three-letter language code for the language.

  • DisplayName. The display name of the custom Web applet in the language identified by the language code.

See Oracle Migration Tool On Demand Guide for reference tables about the following:

• Mappings of three-letter language codes to languages.

See Oracle CRM On Demand Online Help for more information about creating Web applets and custom homepage reports.

Arguments

The following table describes the arguments taken by the HomepageCustomWebAppletUpsert method.

Table Arguments Taken by the HomepageCustomWebAppletUpsert Method

Name	Description	Required	Default	I/O
apData:HomePageCustomWebApplet	The Web applet data to be inserted or updated.	Yes	Not applicable	Input
Status	The status of the call.	Not applicable	Not applicable	Output

Return Value of the Call

The status is returned.

HomeTabCustomWebAppletRead

Extracts My Homepage tab Web applet configuration data.

Usage

Use the HomeTabCustomWebAppletRead method to read configuration data for a My Homepage tab Web applet.

The Web applet is specified with the <DisplayName> child element of apQuery:HomeTabCustomWebApplet.

See HomeTabCustomWebAppletUpsert for information about the data specified in apData:ListOfHomeTabCustomWebApplet.

Arguments

The following table describes the arguments taken by the HomeTabCustomWebAppletRead method.

Table Arguments Taken by the HomeTabCustomWebAppletRead Method

Name	Description	Required	Default	I/O
apQuery:HomeTabCustomWebApplet	The Web applet query criteria.	Yes	Not applicable	Input
apData:ListOfHomeTabCustomWebApplet	The extracted data for the Web applet.	Not applicable	Not applicable	Output

Return Value of the Call

The Web applet data is returned.

HomeTabCustomWebAppletReadAll

Extracts all of the My Homepage tab Web applet configuration data for a company.

Usage

Use the HomeTabCustomWebAppletReadAll method to read all of the My Homepage tab Web applets.

The input argument <Version> specifies the release of Oracle CRM On Demand for which configuration data is returned. The default value is 27, and specified values up to and including 27 return configuration data applicable to Oracle CRM On Demand Release 27.

If the value specified is greater than 27, then all of the configuration data up to the release specified is returned. For example, if a value of 28 is specified, then all of the configuration data in Release 27 plus the newer data up to Release 28 is returned.

See HomeTabCustomWebAppletUpsert for information about the data specified in apData:ListOfHomeTabCustomWebApplet.

Arguments

The following table describes the arguments taken by the HomeTabCustomWebAppletReadAll method.

Table Arguments Taken by the HomeTabCustomWebAppletReadAll Method

Name	Description	Required	Default	I/O
Version	Specifies the release of Oracle CRM On Demand for which configuration data is returned.	No	27	Input
apData:ListOfHomeTabCustomWebApplet	The extracted data for all My Homepage tab Web applets.	Not applicable	Not applicable	Output

Return Value of the Call

The My Homepage tab Web applets are returned.

HomeTabCustomWebAppletUpsert

Updates an existing My Homepage tab Web applet or inserts a new Web applet.

Usage

Use the HomeTabCustomWebAppletUpsert method to insert or update an existing My Homepage tab Web applet or custom report.

If the Enable Language Translation Support for Web Applets check box is selected in the company profile, then you can use the <LanguageCode> and <DisplayName> child elements of the <Translation> element to insert or update translations of the Web applet display name in each language for your company.

The apData:HomeTabCustomWebApplet argument contains the following elements containing My Homepage tab Web applet data:

• DisplayName. The name of the Web applet. Required.

• DisplayNameCurrentUserLang. The name of the Web applet in the language of the currently logged-in user.

• Description. A description for the Web applet.

• Width. The column width of the applet: 1 for Single, 2 for Double.

• Height. The height of the applet in pixels.

• FeedType. Settings for an RSS feed applet:

  • URL. The URL that is invoked when the user clicks the hyperlink.

  • OverrideURLFlag. Whether or not the user can override the URL.

  • TargetWindow. The window in which the Web applet opens: Current Window or New Window.

• HTMLType. Settings for an HTML Web applet:

  • HTMLHeader. HTML code used in an <iframe> element within the HTML header of the page to which you add the Web applet.

  • HTMLBody. HTML code used in an <iframe> element within the HTML body of the page to which you add the Web applet.

• URLType. Settings for a URL Web applet:

  • URL. The URL that is invoked when the user clicks the hyperlink.

• ReportType. Settings for a custom report.

  • ReportPath. The path to the report, which must be located under Shared Folders (required).

  • ReportFlag. Whether the report will run automatically, and users will not have to click a link to update the report. This is applicable only for My Homepage custom reports, and not for global applets.

  • ReportPrompts. Whether any prompts that are configured for the report are displayed at runtime. Corresponds to the Display Report Prompts check box in the UI.

  • RefreshLink. Whether the Refresh link that allows users to refresh the report is available at runtime.

  • PrintLink. Whether the Print link that allows users to print the report is available at runtime.

  • ExportLink. Whether the Export link that allows users to download the report is available at runtime.

• WebAppletReportType. Settings for a Report Web applet.

  • ReportPath. The path to the report, which must be located under Shared Folders (required).

  • ReportParameters. The filters that will be applied to the report at runtime. For example: <data:ReportParameters>P0=1&amp;P1=eq&amp;P2="Account"."Account ID"&amp;P3=%%%Row_Id%%%</data:ReportParameters>. The filter syntax is validated when you insert or update. For more information about specifying parameters, see Oracle CRM On Demand Online Help.

  • ReportPrompts. Whether any prompts that are configured for the report are displayed at runtime. Corresponds to the Display Report Prompts check box in the UI.

    Note: If the <ReportPrompts> element is set to true, then any filters that are specified in the <ReportParameters> element are ignored at runtime, even if no prompts are defined for the analysis.

  • RefreshLink. Whether the Refresh link that allows users to refresh the report is available at runtime.

  • PrintLink. Whether the Print link that allows users to print the report is available at runtime.

  • ExportLink. Whether the Export link that allows users to download the report is available at runtime.

• DashboardType. Settings for a Dashboard Web applet.

  • DashboardPath. The path to the dashboard (required). The dashboard must be located directly in the Dashboards folder under Shared Folders and not at a deeper level. This validation is enforced only in the UI and not via Web service Upsert calls.

  • DashboardParameters. The filters that will be applied to the dashboard at runtime. For example: <data:DashboardParameters>P0=1&amp;P1=eq&amp;P2="Account"."Account ID"&amp;P3=%%%Row_Id%%%</data:DashboardParameters>. The filter syntax is validated when you insert or update. For more information about specifying parameters, see Oracle CRM On Demand Online Help.

• ListOfTranslation. The display names in the languages activated for your company:

  • LanguageCode. The three-letter language code for the language.

  • DisplayName. The display name of the custom Web applet in the language identified by the language code.

See Oracle Migration Tool On Demand Guide for reference tables about the following:

• Mappings of three-letter language codes to languages.

See Oracle CRM On Demand Online Help for more information about creating Web applets and custom reports.

Arguments

The following table describes the arguments taken by the HomeTabCustomWebAppletUpsert method.

Table Arguments Taken by the HomeTabCustomWebAppletUpsert Method

Name	Description	Required	Default	I/O
apData:HomeTabCustomWebApplet	The Web applet data to be inserted or updated.	Yes	Not applicable	Input
Status	The status of the call.	Not applicable	Not applicable	Output

Return Value of the Call

The status is returned.

IndustryRead

Extracts industry configuration data.

Usage

Use the IndustryRead method to extract industry configuration data for your company.

The industry is specified with the <Name> child element of apQuery:Industry.

See IndustryReadAll for information about the industry data specified in apData:Industry.

Arguments

The following table describes the arguments taken by the IndustryRead method.

Table Arguments Taken by the Industry Read Method

Name	Description	Required	Default	I/O
apQuery:Industry	The industry query criteria.	Yes	Not applicable	Input
apData:ListOfIndustry	The extracted industry data.	Not applicable	Not applicable	Output

Return Value of the Call

The industry data is returned.

IndustryReadAll

Extracts all of the industry configuration data for a company.

Usage

Use the IndustryReadAll method to read all of the industry configuration data for your company.

The input argument <Version> specifies the release of Oracle CRM On Demand for which configuration data is returned. The default value is 22, and specified values up to and including 22 return configuration data applicable to Oracle CRM On Demand Release 22.

If the value specified is greater than 22, then all of the configuration data up to the release specified is returned. For example, if a value of 23 is specified, then all of the configuration data in Release 22 plus the new data in Release 23 is returned.

The apdata:Industry argument contains the following elements containing industry data:

• Name. The name of the industry.

• Active. Whether the industry is enabled.

• Type. The type of industry classification used, for example, 4-digit SIC.

• DisplayName. The display name of the industry.

• SICode. The code for the industry according to the Standard Industrial Classification (SIC) system.

• MarkforTranslation. Whether the industry display name is translated.

• ListOfIndustryTranslation. The industry names in the languages activated for your company:

  • LanguageCode. The three-letter language code for the language.

  • Title. The display name of the industry in the language identified by the language code.

• Id. The ID of the industry record (read-only).

Arguments

The following table describes the arguments taken by the IndustryReadAll method.

Table Arguments Taken by the IndustryReadAll Method

Name	Description	Required	Default	I/O
Version	Specifies the release of Oracle CRM On Demand for which configuration data is returned.	No	22	Input
apData:ListOfIndustry	The extracted industry data for the company.	Not applicable	Not applicable	Output

Return Value of the Call

The industry data for the company is returned.

IntegrationEventQueueRead

Extracts all of the configuration data for an integration event queue.

Usage

Use the IntegrationEventQueueRead method to read the configuration data for an integration event queue.

The integration event queue is specified with the <QueueName> child element of apQuery:IntegrationEventQueue.

See IntegrationEventQueueUpsert for information about the data specified in apData:IntegrationEventQueue.

Arguments

The following table describes the arguments taken by the IntegrationEventQueueRead method.

Table Arguments Taken by the IntegrationEventQueueRead Method

Name	Description	Required	Default	I/O
apQuery:IntegrationEventQueue	The integration event queue query criteria.	Yes	Not applicable	Input
apData:IntegrationEventQueue	The extracted integration event queue data.	Not applicable	Not applicable	Output

Return Value of the Call

The integration event queue configuration data is returned.

IntegrationEventQueueReadAll

Extracts all of the integration event queue configuration data for a company.

Usage

Use the IntegrationEventQueueReadAll method to read all of the integration event queue configuration data for all queues.

The input argument <Version> specifies the release of Oracle CRM On Demand for which configuration data is returned. The default value is 40, and specified values up to and including 40 return configuration data applicable to Oracle CRM On Demand Release 40.

If the value specified is greater than 40, then all of the configuration data up to the release specified is returned. For example, if a value of 41 is specified, then all of the configuration data in Release 40 plus the newer data up to Release 41 is returned (which includes the <W3CFormat> element).

See IntegrationEventQueueUpsert for information about the integration event queue configuration data specified in apData:IntegrationEventQueue.

Arguments

The following table describes the arguments taken by the IntegrationEventQueueReadAll method.

Table Arguments Taken by the IntegrationEventQueueReadAll Method

Name	Description	Required	Default	I/O
Version	Specifies the release of Oracle CRM On Demand for which configuration data is returned.	No	40	Input
apData:ListOfIntegrationEventQueue	The extracted integration event queue data.	Not applicable	Not applicable	Output

Return Value of the Call

The integration event queue configuration data is returned.

IntegrationEventQueueUpsert

Updates existing integration event queue data or inserts new queue data.

Usage

Use the IntegrationEventQueueUpsert method to insert or update integration event queue configuration data. The Manage Company privilege is required.

You can use the IntegrationEventQueueUpsert method to clear transactions from an integration event queue. You can clear all transactions from the queue by specifying the value true for the <ClearAllTransactions> element, or you can clear older transactions from the queue by specifying a date value in the <ClearFromDate> element. The upsert operation then clears all of the transactions that occurred before that date from the queue.

The apdata:IntegrationEventQueue argument contains the following elements containing integration event queue data:

• QueueName. The name of the queue (required).

• Description. A description of the usage of the queue.

• Disabled. Whether the queue is disabled.

• Created. The username and time and date for the user who created the queue (read-only).

• Modified. The username and time and date for the user who last updated the queue (read-only).

• FileLimit. The total number of events that the company can store for all queues. If the size of the existing queues matches this number, then you cannot create a new queue. This element is read-only and is ignored for upsert requests.

• UnassignedQueueCapacity. The available size of queue. This element is read-only and is ignored for upsert requests.

• QueueSize. The size of the queue. This size cannot exceed the <UnassignedQueueCapacity> value. Required for insert operations.

• NumberOfTransactions. The number of transactions in the queue. This element is read-only and is ignored for upsert requests.

• ClearAllTransactions. Whether all transactions in the queue should be deleted.

• ClearFromDate. A date and time for which all transactions older than the specified date should be deleted. This must be specified in the xsd:dateTime format.

• NotificationEmailAddress. An email address to which a warning email is to be sent when the queue is full or when the queue reaches a certain size, as specified in <WarningMailQueueSize>.

• WarningMailQueueSize. The size that the queue is allowed to reach before a warning email is sent to the address specified in <NotificationEmailAddress>.

• TimeZone. A value that specifies how the <Created> and <Modified> values are recorded in the integration events that are created using the Web Services v1.0 Schema and written to this queue.

  • UTC. If this value is specified, then the date and time in the GMT time zone are recorded, in the following format:

    MM/DD/YYYY HH:MM:SS

    For example, 06/12/2017 09:44:15, which corresponds to June 12th 2017, 9:44:15 GMT.

  • UTC Format. If this value is specified, then the date and time in the GMT time zone are recorded, in the xsd:dateTime format specified by the W3C standard for Coordinated Universal Time (UCT), as follows:

    YYYY-MM-DDTHH:MM:SSZ

    For example, 2017-06-12T09:44:15Z, which corresponds to June 12th 2017, 9:44:15 GMT.

  • User Time Zone. If this value is specified, then the date and time in the time zone of the user who updated the record are recorded, in the following format:

    MM/DD/YYYY HH:MM:SS

    This value is the default.

  Note: You set the <TimeZone> field for the default queue only. All other queues inherit the setting that is selected for the company's default queue. The <TimeZone> field is returned for all queues, but it is read-only for queues other than the default queue.

• PicklistFormat. The format for recording picklist field values in the integration events, as follows:

  • If you want the values to be recorded as language-independent code (LIC) values, then specify Language Independent Values.

  • If you want the values to be recorded in the language of the user whose action causes the integration event to be created, then specify User Language.

    This element is required for insert operations, and read-only for update operations.

• W3CFormat. The format in which the field values are recorded in the integration events that are created using the Web Services v2.0 Schema and written to this queue, as follows:

  • If the <W3CFormat> element is set to true, then the values in all fields are recorded in the format specified by the W3C for Web Services v2.0 Schema integration events.

  • If the <W3CFormat> element is set to false, then the values in Date and Boolean field types are recorded in the format that was used in releases earlier than Release 41 of Oracle CRM On Demand. The values in all other fields are recorded in the format specified by the W3C for Web Services v2.0 Schema integration events.

  Note: If you set the <W3CFormat> element to true when inserting or updating the integration event queue data, then after the queue is created or updated, the <W3CFormat> field becomes read-only and it cannot be changed.

Arguments

The following table describes the arguments taken by the IntegrationEventQueueUpsert method.

Table Arguments Taken by the IntegrationEventQueueUpsert Method

Name	Description	Required	Default	I/O
apData:IntegrationEventQueue	The integration event queue data to be inserted or updated.	Yes	Not applicable	Input
Status	The status of the call.	Not applicable	Not applicable	Output

Return Value of the Call

The status is returned.

LeadConversionMappingRead

Extracts lead conversion mapping data.

Usage

Use the LeadConversionMappingRead method to extract lead conversion mapping data matching the input criteria.

The field on the Lead record type is specified with the <LeadFieldName> child element of apQuery:FieldMapping.

Note: To extract mappings for the Deal Registration record type, the Manage PRM Access privilege is required.

See LeadConversionMappingUpsert for information about the lead mapping data specified in apData:FieldMapping.

Arguments

The following table describes the arguments taken by the LeadConversionMappingRead method.

Table Arguments Taken by the LeadConversionMappingRead Method

Name	Description	Required	Default	I/O
apdata:FieldMapping	The lead mapping query criteria (input) or lead mapping data (output).	Yes	Not applicable	Input/Output

Return Value of the Call

The lead conversion mapping data is returned.

LeadConversionMappingReadAll

Extracts all of the lead conversion mapping data for a company.

Usage

Use the LeadConversionMappingReadAll method to read all of the lead conversion mapping data.

Note: To extract mappings for the Deal Registration record type, the Manage PRM Access privilege is required.

If the <IncludeAll> child element of apQuery:LeadConversionMapping specifies true, then the method returns all of the fields on the Lead record type that can be mapped, even if no mapping exists for the fields. If <IncludeAll> specifies false, or is not included in the request, then the method returns only the data for fields on the Lead record type that are mapped to at least one field on one or more of the Account, Contact, Deal Registration, or Opportunity record types.

See LeadConversionMappingUpsert for information about the lead mapping data specified in apData:FieldMapping.

Arguments

The following table describes the arguments taken by the LeadConversionMappingReadAll method.

Table Arguments Taken by the LeadConversionMappingReadAll Method

Name	Description	Required	Default	I/O
apData:ListOfFieldMapping	The extracted data for all lead conversion mapping.	Not applicable	Not applicable	Output

Return Value of the Call

The lead conversion mapping data is returned.

LeadConversionMappingUpsert

Updates existing lead conversion mapping data or inserts new mapping data.

Usage

Use the LeadConversionMappingUpsert method to insert or update lead conversion mapping data.

Note: To insert or update mappings for the Deal Registration record type, the Manage PRM Access privilege is required.

The apdata:FieldMapping argument contains the following elements containing lead conversion mapping data:

• LeadFieldName. The system name of a field on the Lead record type.

• ContactFieldName. The system name of the field on the Contact record type that the field on the Lead record type is mapped to, if a mapping exists. If no field is specified here, and if a mapping previously existed between the specified field on the Lead record type and a field on the Contact record type, then the mapping is deleted.

• OpportunityFieldName. The system name of the field on the Opportunity record type that the field on the Lead record type is mapped to, if a mapping exists. If no field is specified here, and if a mapping previously existed between the specified field on the Lead record type and a field on the Opportunity record type, then the mapping is deleted.

• AccountFieldName. The system name of the field on the Account record type that the field on the Lead record type is mapped to, if a mapping exists. If no field is specified here, and if a mapping previously existed between the specified field on the Lead record type and a field on the Account record type, then the mapping is deleted.

• DealRegistrationFieldName. The system name of the field on the Deal Registration record type that the field on the Lead record type is mapped to, if a mapping exists. If no field is specified here, and if a mapping previously existed between the specified field on the Lead record type and a field on the Opportunity record type, then the mapping is deleted.

Arguments

The following table describes the arguments taken by the LeadConversionMappingUpsert method.

Table Arguments Taken by the LeadConversionMappingUpsert Method

Name	Description	Required	Default	I/O
apData:LeadConversionMapping	The lead conversion mapping data to be inserted or updated.	Yes	Not applicable	Input
Status	The status of the call.	Not applicable	Not applicable	Output

Return Value of the Call

The status is returned.

ListRead

Extracts list configuration data.

Usage

Use the ListRead method to read list configuration data.

You can use the following elements of apQuery:List to query lists:

• <RecordType>

• <ListName>

• <ListType>

• <CreatedByAlias>

• <ModifiedByAlias>

You can read the following types of list:

• Public lists. No privileges are required to read public lists.

• Private lists. To read private lists defined by all users in the company, the Manage Private Lists privilege is required. No privilege is required to read private lists created by the currently logged in user.

• Role-specific lists. To read all role-specific lists defined for the company, the Manage Public Lists privilege is required.

• System lists. To return system lists you can specify System for <ListType>. Otherwise, if the <IncludeAll> child element of apQuery:List specifies true, the ListRead method returns all lists including system lists. If <IncludeAll> specifies false, or is not included in the request, the method returns all configuration data except system list data.

Note: If the ListRead method is invoked with any search fields other than <RecordType>, or <ListType> with a value other than System, then even if <IncludeAll> is true, the system lists are not returned.

The following table shows which lists you can read when you have the Manage Public Lists or Manage Private Lists privilege:

Table Privileges and Access to Lists

Manage Public Lists	Manage Private Lists	Private Lists	Role-specific Lists	Public Lists
Yes	Yes	All	All	All
Yes	No	Private lists created by currently logged in user only	All	All
No	Yes	All	Lists for currently logged in user’s role only	All
No	No	Private lists created by currently logged in user only	Lists for currently logged in user’s role only	All

Note: Lists for the current user's role can include lists not created by the current user.

The lists returned can include private lists with the same name, but created by different users, and role specific lists with the same name, but for different roles.

The following data is returned in apData:List:

• RecordType. The record type.

• ListName. The name of the list in the language of the currently logged-in user.

• ListType. The type of list; possible values are: Public, Private, Role Specific, System.

• CreatedByAlias. The alias of the user who created the list.

• ModifiedByAlias. The alias of the user who last modified the list.

• RoleName. For role specific lists only, the role to which the list is applicable.

• CreatedById. The identifier of the user who created the list.

• ModifiedById. The identifier of the user who last modified the list.

• CreatedDate. The date and time the list was created.

• ModifiedDate. The date and time the list was last modified.

• Description.. A description of the list.

• SearchIn. The record set from which records are returned, for example, All records I can see, All records I own.

• CaseInsensitiveFlag. Whether fields are case sensitive in searches.

• LanguageCode. For system lists, the language code for the currently logged in user. For other lists, the language code in which the list was created.

• ListOfFilterInformation. The filter information for the list, contained in child elements of the <FilterInfo> element:

  • Conjunction. The operator And or Or.

  • FieldName. The system name of the field.

  • Condition. The condition for the filter.

  • FilterValue. The filter value.

  • FilterValueAssocId. The association ID (row ID) for a filter value for association control fields such as Contact Full Name, Account Name, Owner Alias, and so on, where the condition is Equal to.

• ListOfSelectedFields. The fields selected for display in search results contained in child elements of the <SelectedFieldInfo> element:

  • SelectedField. The system name of the field.

  • SortOrder. The sort order of a field used for sorting of search results: ASC for ascending or DESC for descending.

  • SortPosition. The position of a field within the list of fields used for sorting

For more information about working with lists, see Oracle CRM On Demand Online Help.

Arguments

The following table describes the arguments taken by the ListRead method.

Table Arguments Taken by the List Read Method

Name	Description	Required	Default	I/O
apQuery:List	The list query criteria.	Yes	Not applicable	Input
apData:ListOfLists	The extracted list configuration data.	Not applicable	Not applicable	Output

Return Value of the Call

The list data is returned.

ListReadAll

Extracts all of the list configuration data for a company.

Usage

Use the ListReadAll method to read all of the list data for all objects. See ListRead for information about the privileges required to access the various types of list.

If the input argument <IncludeAll> specifies true, the method returns all configuration data, including system list data. If <IncludeAll> specifies false, or is not included in the request, the method returns all configuration data except system list data.

See ListRead for information about the list data specified in apData:List.

Arguments

The following table describes the arguments taken by the ListReadAll method.

Table Arguments Taken by the ListReadAll Method

Name	Description	Required	Default	I/O
IncludeAll	If true, extracts all list configuration data including system list data.	No	false	Input
apData:ListOfLists	The extracted list data.	Not applicable	Not applicable	Output

Return Value of the Call

The list data is returned.

ListAccessAndOrderRead

Extracts all of the list access and order configuration data for each role for an object.

Usage

Use the ListAccessAndOrderRead method to read the list access and display order data for an object.

The object is specified with the <ObjectName> child element of apQuery:ListAccessAndOrder.

See ListAccessAndOrderUpsert for information about the list access and display order data specified in apData:ListAccessAndOrder.

Arguments

The following table describes the arguments taken by the ListAccessAndOrderRead method.

Table Arguments Taken by the ListAccessAndOrderRead Method

Name	Description	Required	Default	I/O
apQuery:ListAccessAndOrder	The list access query criteria.	Yes	Not applicable	Input
apData:ListOfListAccessAndOrder	The extracted list access and display order data.	Not applicable	Not applicable	Output

Return Value of the Call

The list access data is returned.

ListAccessAndOrderReadAll

Extracts all of the list access and display order configuration data for a company.

Usage

Use the ListAccessAndOrderReadAll method to read all of the list access and display order data for all objects.

See ListAccessAndOrderUpsert for information about the list access and display order data specified in apData:ListAccessAndOrder.

Arguments

The following table describes the arguments taken by the ListAccessAndOrderReadAll method.

Table Arguments Taken by the ListAccessAndOrderReadAll Method

Name	Description	Required	Default	I/O
apData:ListOfListAccessAndOrder	The extracted list access and display order data.	Not applicable	Not applicable	Output

Return Value of the Call

The list access and display order data is returned.

ListAccessAndOrderUpsert

Updates existing list access and display order data or inserts new data.

Usage

Use the ListAccessAndOrderUpsert method to insert or update list access and order data for each role for an object.

The apdata:ListAccessAndOrder argument contains the following elements containing list access and display order data:

• ObjectName. The name of the object (required).

• RoleName. The name of the role (required).

• ModifiedBy. The username and time and date for the user who last updated the List Order Layout (read-only).

• ListOfListAccessAndOrderList. Contains all of the lists available for a role. The data for a particular list is contained in the following child elements of <ListAccessAndOrderList>:

  • ListName. The name of the list.

  • Order. An integer value indicating the list box in the List Order Layout page in which the list appears and the display order, if it appears in the Show in Short List box:

    • -2. The list appears in the All Lists box.

    • -1. The list appears in the Lists Available for this Role box.

    • 2 through n. The list appears in the Show in Short List box and the integer value indicates the order of the list within the box starting with the value 2 for the topmost list, and so on.

See Oracle Migration Tool On Demand Guide for reference tables about the mappings of object names to the display names for the objects in the Oracle CRM On Demand user interface.

Arguments

The following table describes the arguments taken by the ListAccessAndOrderUpsert method.

Table Arguments Taken by the ListAccessAndOrderUpsert Method

Name	Description	Required	Default	I/O
apData:ListAccessAndOrder	The list access and display order data to be inserted or updated.	Yes	Not applicable	Input
Status	The status of the call.	Not applicable	Not applicable	Output

Return Value of the Call

The status is returned.

PageLayoutFieldRead

Extracts all of the field configuration data for a detail page of an object.

Usage

Use the PageLayoutFieldRead method to read the field data for an object’s detail page.

The object is specified with the <ObjectName> child element of apQuery:PageLayout.

If the <CurrentUserOnly> child element of apQuery:PageLayout specifies true, page layout field data for the current user only is returned.

If the <IncludeAll> child element of apQuery:PageLayout specifies true, the method returns configuration data including preconfigured and customized data. If <IncludeAll> specifies false, or is not included in the request, the method returns customized configuration data only.

See PageLayoutFieldUpsert for information about the page layout field data specified in apData:PageLayout.

Arguments

The following table describes the arguments taken by the PageLayoutFieldRead method.

Table Arguments Taken by the PageLayoutFieldRead Method

Name	Description	Required	Default	I/O
apQuery:PageLayout	The page layout query criteria.	Yes	Not applicable	Input
apData:ListOfPageLayout	The extracted page layout field data.	Not applicable	Not applicable	Output

Return Value of the Call

The page layout fields are returned.

PageLayoutFieldReadAll

Extracts all of the field configuration data for detail pages for a company.

Usage

Use the PageLayoutFieldReadAll method to read all of the field data for detail pages.

If the input argument <CurrentUserOnly> specifies true, all of the page layout field data for the current user only is returned.

If the input argument <IncludeAll> specifies true, the method returns all configuration data, including preconfigured and customized data. If <IncludeAll> specifies false, or is not included in the request, the method returns customized configuration data only.

The input argument <Version> specifies the release of Oracle CRM On Demand for which configuration data is returned. The default value is 27, and specified values up to and including 27 return configuration data applicable to Oracle CRM On Demand Release 27.

If the value specified is greater than 27, then all of the configuration data up to the release specified is returned. For example, if a value of 28 is specified, then all of the configuration data in Release 27 plus the newer data up to Release 28 is returned.

See PageLayoutFieldUpsert for information about the page layout field data specified in apData:PageLayout.

Arguments

The following table describes the arguments taken by the PageLayoutFieldReadAll method.

Table Arguments Taken by the PageLayoutFieldReadAll Method

Name	Description	Required	Default	I/O
CurrentUserOnly	If true, extracts data for the current user only.	No	false	Input
IncludeAll	If true, extracts all configuration data and not just customized configuration data.	No	false	Input
Version	Specifies the release of Oracle CRM On Demand for which configuration data is returned.	No	27	Input
apData:ListOfPageLayout	The extracted page layout field data.	Not applicable	Not applicable	Output

Return Value of the Call

The page layout fields are returned.

PageLayoutFieldUpsert

Updates existing page layout field data or inserts new page layout field data.

Usage

Use the PageLayoutFieldUpsert method to insert or update field data for a detail page layout.

The apdata:PageLayout argument contains the following elements containing page layout field data:

• ObjectName. The name of the object.

• LayoutName. The name of the page layout.

• Description. A description of the page layout.

• ListOfPageLayoutField. Contains all of the fields for the page layout. The data for a particular field is contained in the following child elements of <PageLayoutField>:

  • FieldName. The name of the field.

  • ReadOnly. Whether the field is read-only.

  • Required.. Whether the field is required.

  • AlwaysOnLayout. Whether the field is always on the page layout. A value of true indicates that the field cannot be removed from the page layout by the user.

  • Section. An integer identifying the section in which the field appears. The value 0 represents the first section, 1 the next section, and so on.

  • Column. The column within the section in which the field appears. The value 0 represents the left-most column.

  • Row. The row within the section in which the field appears. The value 0 represents the first row within a section and column, 1 the next row, and so on.

See Oracle Migration Tool On Demand Guide for reference tables about the mappings of object names to the display names for the objects in the Oracle CRM On Demand user interface.

Arguments

The following table describes the arguments taken by the PageLayoutFieldUpsert method.

Table Arguments Taken by the PageLayoutFieldUpsert Method

Name	Description	Required	Default	I/O
apData:PageLayout	The page layout field data to be inserted or updated.	Yes	Not applicable	Input
Status	The status of the call.	Not applicable	Not applicable	Output

Return Value of the Call

The status is returned.

PageLayoutRelatedInformationRead

Extracts all of the related information for a detail page layout for an object.

Usage

Use the PageLayoutRelatedInformationRead method to read all of the related information data for an object.

The object is specified with the <ObjectName> child element of apQuery:PageLayoutRelatedInformation.

If the <CurrentUserOnly> child element of apQuery:PageLayoutRelatedInformation specifies true, related information data for the current user only is returned.

If the <IncludeAll> child element of apQuery:PageLayoutRelatedInformations specifies true, the method returns configuration data including preconfigured and customized data. If <IncludeAll> specifies false, or is not included in the request, the method returns customized configuration data only.

The input argument <Version> specifies the release of Oracle CRM On Demand for which configuration data is returned. The default value is 41, and specified values up to and including 41 return configuration data applicable to Oracle CRM On Demand Release 41.

If the value specified is greater than 41, then all of the configuration data up to the release specified is returned. For example, if a value of 42 is specified, then all of the configuration data in Release 41 plus the newer data up to Release 42 is returned (which includes the <NewRecordLayout> element).

See PageLayoutRelatedInformationUpsert for information about the page layout related information specified in apData:PageLayoutRelatedInformation.

Arguments

The following table describes the arguments taken by the PageLayoutRelatedInformationRead method.

Table Arguments Taken by the PageLayoutRelatedInformationRead Method

Name	Description	Required	Default	I/O
Version	Specifies the release of Oracle CRM On Demand for which configuration data is returned.	No	41	Input
apQuery:PageLayoutRelatedInformation	The related information query criteria.	Yes	Not applicable	Input
apData:ListOfPageLayoutRelatedInformation	The extracted page layout related information.	Not applicable	Not applicable	Output

Return Value of the Call

The page layout related information is returned.

PageLayoutRelatedInformationReadAll

Extracts all of the related information for detail page layouts for a company.

Usage

Use the PageLayoutRelatedInformationReadAll method to read all of the related information data for detail page layouts.

If the input argument <CurrentUserOnly> is true, all of the related information data for the current user only is returned.

If the input argument <IncludeAll> specifies true, the method returns all configuration data, including preconfigured and customized data. If <IncludeAll> specifies false, or is not included in the request, the method returns customized configuration data only.

The input argument <Version> specifies the release of Oracle CRM On Demand for which configuration data is returned. The default value is 41, and specified values up to and including 41 return configuration data applicable to Oracle CRM On Demand Release 41.

If the value specified is greater than 41, then all of the configuration data up to the release specified is returned. For example, if a value of 42 is specified, then all of the configuration data in Release 41 plus the newer data up to Release 42 is returned (which includes the <NewRecordLayout> element).

See PageLayoutRelatedInformationUpsert for information about the page layout related information specified in apData:PageLayoutRelatedInformation.

Arguments

The following table describes the arguments taken by the PageLayoutRelatedInformationReadAll method.

Table Arguments Taken by the PageLayoutRelatedInformationReadAll Method

Name	Description	Required	Default	I/O
CurrentUserOnly	If true, extracts data for the current user only	No	false	Input
IncludeAll	If true, extracts all configuration data and not just customized configuration data.	No	false	Input
Version	Specifies the release of Oracle CRM On Demand for which configuration data is returned.	No	41	Input
apData:ListOfPageLayoutRelatedInformation	The extracted page layout related information.	Not applicable	Not applicable	Output

Return Value of the Call

The page layout related information is returned.

PageLayoutRelatedInformationUpsert

Updates existing page layout related information or inserts new page layout related information.

Usage

Use the PageLayoutRelatedInformationUpsert method to insert or update related information for a detail page layout.

The apdata:PageLayoutRelatedInformation argument contains the following elements containing related information for a page layout:

• ObjectName. The name of the object.

• LayoutName. The name of the page layout.

• ListOfPageRelatedInformation. Contains all of the related information for the page layout. The data for a particular related information section is contained in the following child elements of <PageRelatedInformation>:

• Name. A child object ID, equivalent to the name of a related information section . See Oracle Migration Tool On Demand Guide for reference tables about the mapping of child object IDs to UI display names for the child objects.

• Availability. An integer with the range of values -1 through 1, specifying in which list the related information appears in the page layout: Not Available, Available, or Displayed respectively.

  For values of 1 (Displayed), the order of the <PageRelatedInformation> elements determines the order in which the related information sections are listed in the layout in the UI.

• RelatedInformationLayout. The name of the corresponding related information layout.

• NewRecordLayout. The name of the layout for creating records from a list of related records.

See Oracle Migration Tool On Demand Guide for reference tables about the mappings of object names to the display names for the objects in the Oracle CRM On Demand user interface.

Arguments

The following table describes the arguments taken by the PageLayoutRelatedInformationUpsert method.

Table Arguments Taken by the PageLayoutRelatedInformationUpsert Method

Name	Description	Required	Default	I/O
apData:PageLayoutRelatedInformation	The page layout related information to be inserted or updated.	Yes	Not applicable	Input
Status	The status of the call.	Not applicable	Not applicable	Output

Return Value of the Call

The status is returned.

PageLayoutSectionReadAll

Extracts all of the section data for detail page layouts for a company.

Usage

Use the PageLayoutSectionReadAll method to read all of the section data for detail page layouts.

If the input argument <CurrentUserOnly> is true, all of the related information data for the current user only is returned.

If the input argument <IncludeAll> specifies true, the method returns all configuration data, including preconfigured and customized data. If <IncludeAll> specifies false, or is not included in the request, the method returns customized configuration data only.

See PageLayoutSectionUpsert for information about the page layout section data specified in apData:PageLayoutFormSection.

Arguments

The following table describes the arguments taken by the PageLayoutSectionReadAll method.

Table Arguments Taken by the PageLayoutSectionReadAll Method

Name	Description	Required	Default	I/O
apData:ListOfPageLayoutForm	The extracted page layout section data.	Not applicable	Not applicable	Output

Return Value of the Call

The page layout section data is returned.

PageLayoutSectionUpsert

Updates existing page layout section data or inserts new page layout section data.

Usage

Use the PageLayoutSectionUpsert method to insert or update section data for a detail page layout.

The apdata:PageLayoutFormSection argument contains the following elements containing page layout section data:

• ObjectName. The name of the object.

• LayoutName. The name of the page layout.

• ListOfPageFormSection. The section data for each section. The data is contained in the following child elements of <PageFormSection>:

  • SectionSequence. The position in which the section appears in the page layout.

  • ListOfFormSectionTranslation. The section names in the languages activated for your company. The data for a particular section is contained in the following child elements of <FormSectionTranslation>:

    • LangId The three-letter language code for the language.

    • DisplayName The display name of the section in the language identified by the language code.

See the Oracle Migration Tool On Demand Guide for reference tables about the mappings of three-letter language codes to languages.

Arguments

The following table describes the arguments taken by the PageLayoutSectionUpsert method.

Table Arguments Taken by the PageLayoutSectionUpsert Method

Name	Description	Required	Default	I/O
apData:PageLayoutFormSection	The page layout section data to be inserted or updated.	Yes	Not applicable	Input
Status	The status of the call.	Not applicable	Not applicable	Output

Return Value of the Call

The status is returned.

PicklistRead

Extracts picklist configuration data.

Usage

Use the PicklistRead method to extract picklist configuration data for an object.

The object is specified with the <ObjectName> child element of apQuery:PicklistSet.

The input argument <Version> specifies the release of Oracle CRM On Demand for which configuration data is returned. The default value is 40, and specified values up to and including 40 return configuration data applicable to Oracle CRM On Demand Release 40.

If the value specified is greater than 40, then all of the configuration data up to the release specified is returned. For example, if a value of 41 is specified, then all of the configuration data in Release 40 plus the newer data up to Release 41 is returned (which includes the <Description> element).

If the <IncludeAll> child element of apQuery:PicklistSet specifies true, then the method returns configuration data including preconfigured and customized data. However, the data returned does not include any pre-configured read-only picklist data. If <IncludeAll> specifies false, or is not included in the request, then the method returns customized configuration data only.

You can use the <Disabled> child element of <PickListValue> to filter for active and inactive (disabled) picklist values for a particular picklist. To filter, you must specify <ObjectName> and <Name> to identify the picklist, and a value for <Disabled>. If you specify a value of true for <Disabled>, all inactive picklist values are returned, and if you specify false, all active picklist values are returned. If you do not specify a value for <Disabled>, both active and inactive picklist values are returned.

See PicklistUpsert for information about the picklist data specified in apData:PicklistSet.

Arguments

The following table describes the arguments taken by the PicklistRead method.

Table Arguments Taken by the PicklistRead Method

Name	Description	Required	Default	I/O
Version	Specifies the release of Oracle CRM On Demand for which configuration data is returned.	No	40	Input
apQuery:PicklistSet	The picklist query criteria.	Yes	Not applicable	Input
apData:ListOfPicklistSet	The extracted picklist data.	Not applicable	Not applicable	Output

Return Value of the Call

The picklists for the object are returned.

PicklistReadAll

Extracts all of the picklist configuration data for a company.

Usage

Use the PicklistReadAll method to read all of the picklists except read-only picklists.

If the input argument <IncludeAll> specifies true, the method returns all configuration data, including preconfigured and customized data. However, the data returned does not include any preconfigured read-only picklist data. If <IncludeAll> specifies false, or is not included in the request, the method returns customized configuration data only.

If the value specified in the <Version> input argument is greater than 29, then all of the configuration data up to the release specified is returned. For example, if a value of 30 is specified, then all of the configuration data in Release 29 plus the newer data up to Release 30 is returned (which includes the <WebSvcTag> element). If a value of 41 is specified, then all of the configuration data in Release 40 plus the newer data up to Release 41 is returned (which includes the <Description> element).

See PicklistUpsert for information about the picklist data specified in apData:PicklistSet.

Arguments

The following table describes the arguments taken by the PicklistReadAll method.

Table Arguments Taken by the PicklistReadAll Method

Name	Description	Required	Default	I/O
IncludeAll	If true, extracts all configuration data and not just customized configuration data.	No	false	Input
Version	Specifies the release of Oracle CRM On Demand for which configuration data is returned.	No	29	Input
apData:ListOfPicklistSet	The extracted data for all picklists for all objects.	Not applicable	Not applicable	Output

Return Value of the Call

The picklists are returned.

PicklistUpsert

Updates an existing set of picklists or inserts a new set of picklists.

Usage

Use the PicklistUpsert method to insert a set of picklists or update an existing set of picklists for an object.

The object is specified with the <ObjectName> element of apdata:PicklistSet.

The apdata:PicklistSet argument contains the following elements containing picklist data for each picklist:

• Name. The system name of the picklist field (required). When performing an insert operation, this name is used as the display name. You can use the FieldManagementRead method to obtain the system name of the picklist field.

• WebSvcTag. The Web Services v2.0 integration tag name for the picklist field. This element is read-only and is ignored in upsert operations.

• OrderAllLanguages. Whether the values in the picklist field are to be ordered alphabetically for all languages. Valid values are Y (the picklist values are to be ordered alphabetically for all languages) or N (the picklist values are to be ordered according to the values specified by <Order>).

• ListOfPicklistValues. The values for the picklist as contained in child elements of <PickListValue>:

  • ValueId. An identifier assigned to the picklist value. This element maps to the Id field in the Edit Picklist window for the picklist field in the UI. It is the language-independent name for the picklist value.

  • Disabled. Whether the picklist value is disabled.

  • ListOfValueTranslations. The picklist values in the languages activated for your company, contained in child elements of <ValueTranslation>:

    • LanguageCode. The three-letter language code for the language.

    • Value. The picklist value in the language identified by the language code.

    • Order. The order number of the picklist value according to the language identified by the language code.

      Note: <Order> is a required value. If <OrderAllLanguages> specifies Y (the picklist values are to be ordered alphabetically for all languages), then the value in <Order> is ignored. If <OrderAllLanguages> specifies N or is not specified, then the picklist values are ordered according to the values specified in <Order>.

    • Description. The description of the picklist value in the language identified by the language code.

See Oracle Migration Tool On Demand Guide for reference tables about the following:

• Mappings of three-letter language codes to languages.

• Mappings of object names to the display names for the objects in the Oracle CRM On Demand user interface.

Arguments

The following table describes the arguments taken by the PicklistUpsert method.

Table Arguments Taken by the Picklist Upsert Method

Name	Description	Required	Default	I/O
apData:PicklistSet	The picklist data to be inserted or updated.	Yes	Not applicable	Input
Status	The status of the call.	Not applicable	Not applicable	Output

Return Value of the Call

The status is returned.

PicklistValueGroupRead

Extracts picklist value group configuration data.

Usage

Use the PicklistValueGroupRead method to extract picklist value group configuration data.

The picklist value group is specified with the <PicklistValueGroupName> or <PicklistValueGroupId> child element of apQuery:PicklistValueGroup so that you can query by both picklist value group name and row ID.

See PicklistValueGroupUpsert for information about the picklist value group data specified in apData:PicklistValueGroupSet.

Arguments

The following table describes the arguments taken by the PicklistValueGroupRead method.

Table Arguments Taken by the PicklistValueGroupRead Method

Name	Description	Required	Default	I/O
apQuery:ListOfPicklistValueGroup	The picklist value group query criteria.	Yes	Not applicable	Input
apData:ListOfPicklistValueGroupSet	The extracted picklist value group data.	Not applicable	Not applicable	Output

Return Value of the Call

The picklist value group is returned.

PicklistValueGroupReadAll

Extracts all of the picklist value group configuration data for a company.

Usage

Use the PicklistValueGroupReadAll method to read all of the picklist value groups.

If the input argument <IncludeAll> specifies true, the method returns all configuration data, including preconfigured and customized data. If <IncludeAll> specifies false, or is not included in the request, the method returns customized configuration data only.

See PicklistValueGroupUpsert for information about the picklist value group data specified in apData:PicklistValueGroupSet.

Arguments

The following table describes the arguments taken by the PicklistValueGroupReadAll method.

Table Arguments Taken by the PicklistValueGroupReadAll Method

Name	Description	Required	Default	I/O
IncludeAll	If true, extracts all configuration data and not just customized configuration data.	No	false	Input
apData:ListOfPicklistValueGroupSet	The extracted data for all picklist value groups.	Not applicable	Not applicable	Output

Return Value of the Call

The picklist value groups are returned.

PicklistValueGroupUpsert

Updates an existing set of picklist value groups or inserts a new set of picklist value groups.

Usage

Use the PicklistValueGroupUpsert method to insert a set of picklist value groups or update an existing set of picklist value groups.

The apdata:PicklistValueGroupSet argument contains the following elements containing picklist value group data:

• PicklistValueGroupName. The name of the picklist value group.

• PicklistValueGroupId. The row ID of the picklist value group.

• Description. A description of the picklist value group.

• ListOfPicklistTypeSet. The picklists that are mapped to the picklist value group:

  • ObjectName. The name of the object containing the picklist.

  • FieldName. The field name of the picklist.

• ListOfLicNameSet. The language-independent picklist values mapped to the picklist value group:

  • LicName. The language-independent picklist value.

Arguments

The following table describes the arguments taken by the PicklistValueGroupUpsert method.

Table Arguments Taken by the PicklistValueGroupUpsert Method

Name	Description	Required	Default	I/O
apData:ListOfPicklistValueGroupSet	The picklist value group data to be inserted or updated.	Yes	Not applicable	Input
Status	The status of the call.	Not applicable	Not applicable	Output

Return Value of the Call

The status is returned.

ProcessAdministrationRead

Extracts process administration configuration data.

Usage

Use the ProcessAdministrationRead method to extract process administration configuration data. The Process Administration privilege is required.

Note: The ProcessAdministrationRead method does not read the field setup and related access control configuration data for transition states.

You can query process administration data using the following child elements of apQuery:Process:

• <RecordType>

• <ProcessName>

• <RecordType> + <ProcessName>

See ProcessAdministrationUpsert for information about the process administration data specified in apData:Process.

Arguments

The following table describes the arguments taken by the ProcessAdministrationRead method.

Table Arguments Taken by the ProcessAdministrationRead Method

Name	Description	Required	Default	I/O
apQuery:Process	The process administration query criteria.	Yes	Not applicable	Input
apData:ListOfProcess	The extracted process administration data.	Not applicable	Not applicable	Output

Return Value of the Call

The process administration data is returned.

ProcessAdministrationReadAll

Extracts all of the process administration configuration data for a company.

Usage

Use the ProcessAdministrationReadAll method to read all of the process administration data. The Process Administration privilege is required.

Note: The ProcessAdministrationReadAll method does not read the field setup and related access control configuration data for transition states.

See ProcessAdministrationUpsert for information about the process administration data specified in apData:Process.

Arguments

The following table describes the arguments taken by the ProcessAdministrationReadAll method.

Table Arguments Taken by the ProcessAdministrationReadAll Method

Name	Description	Required	Default	I/O
apData:ListOfProcess	The extracted process administration data.	Not applicable	Not applicable	Output

Return Value of the Call

The process administration data is returned.

ProcessAdministrationUpsert

Updates existing process administration data or inserts new process administration data.

Usage

Use the ProcessAdministrationUpsert method to insert process administration data or update existing process administration data. The Process Administration privilege is required.

Note: The ProcessAdministrationUpsert method does not insert or update the field setup and related access control configuration data for transition states.

The apdata:Process argument contains the following elements containing process administration data:

• RecordType. The record type (required).

• ProcessName. The name of the process (required).

• PrimaryField. The field that is used as a filter to restrict the process to certain records of the record type (read-only). Only the Activity record type supports the use of a primary field.

• TransitionField. The field in the record type that determines the transition of records from one transition state to another (read-only). The Status field is used as the transition field for all supported record types.

• Description. A description of the process.

• Order. The order of the process within the record type (read-only).

• Default. Whether the process is the default process within the record type (read-only).

• ListOfPrimaryValues. The primary values for the process, which are contained in <Value> child elements of <PrimaryValues>.

• ListOfTransitionStates. The transition states for the process, contained in the following child elements of <TransitionState>.

  • State. The transition state (required). Possible values depend on the record type. For upsert operations, the value in the <State> element must match an existing picklist value in the Status field for the record type.

  • Category. The sales category with which the transition state is associated.

  • Description. A description of the transition state.

  • Created. The user who created the transition state data, with the date and time of creation (read-only).

  • Modified. The user who modified the transition state data, with the date and time of modification (read-only).

  • Condition. An expression that determines whether a record can move to the transition state. You cannot use any calculated fields in the expression.

  • ErrorMessage. The error message that appears if the condition set for the transition state is not met when a user tries to move a record of the record type specified in the process to the transition state.

  • DisableUpdate. Whether records can be updated (false) or not (true) when they are in the transition state.

  • DisableDeleteOrRemove. Whether records can be deleted (false) or not (true) when they are in the transition state.

For upsert operations <RecordType> is a user key. For transition states, the user key is <State>.

For more information about process administration, see Oracle CRM On Demand Online Help.

Arguments

The following table describes the arguments taken by the ProcessAdministrationUpsert method.

Table Arguments Taken by the ProcessAdministrationUpsert Method

Name	Description	Required	Default	I/O
apData:Process	The process administration data to be inserted or updated.	Yes	Not applicable	Input
Status	The status of the call.	Not applicable	Not applicable	Output

Return Value of the Call

The status is returned.

RelatedInformationLayoutRead

Extracts all of the related information layout data for an object.

Usage

Use the RelatedInformationLayoutRead method to read all of the related information layout data for an object.

The object is specified with the <ObjectName> child element of apQuery:RelatedInformationLayout.

If the <CurrentUserOnly> child element of apQuery:RelatedInformationLayout specifies true, related information layout data for the current user only is returned.

If the <IncludeAll> child element of apQuery:RelatedInformationLayout specifies true, the method returns configuration data including preconfigured and customized data. If <IncludeAll> specifies false, or is not included in the request, the method returns customized configuration data only.

The <Version> child element of apQuery:RelatedInformationLayout specifies the release of Oracle CRM On Demand for which configuration data is extracted. The default value is 31, so to extract Release 32 or later functionality, you must specify a higher value than 31.

See RelatedInformationLayoutUpsert for information about the related information layout data specified in apData:RelatedInformationLayout.

Arguments

The following table describes the arguments taken by the RelatedInformationLayoutRead method.

Table Arguments Taken by the RelatedInformationLayoutRead Method

Name	Description	Required	Default	I/O
apQuery:RelatedInformationLayout	The related information layout query criteria.	Yes	Not applicable	Input
apData:ListOfRelatedInformationLayout	The extracted related information layout data.	Not applicable	Not applicable	Output

Return Value of the Call

The related information layout data is returned.

RelatedInformationLayoutReadAll

Extracts all of the related information layout data for a company.

Usage

Use the RelatedInformationLayoutReadAll method to read all of the related information layout data for a company.

If the input argument <CurrentUserOnly> is true, all of the related information layout data for the current user only is returned.

If the input argument <IncludeAll> specifies true, the method returns all configuration data, including preconfigured and customized data. If <IncludeAll> specifies false, or is not included in the request, the method returns customized configuration data only.

The input argument <Version> specifies the release of Oracle CRM On Demand for which configuration data is extracted. The default value is 31, so to extract Release 32 or later functionality, you must specify a higher value than 31.

See RelatedInformationLayoutUpsert for information about the related information data specified in apData:RelatedInformationLayout.

Arguments

The following table describes the arguments taken by the RelatedInformationLayoutReadAll method.

Table Arguments Taken by the RelatedInformationLayoutReadAll Method

Name	Description	Required	Default	I/O
CurrentUserOnly	If true, extracts data for the current user only	No	false	Input
IncludeAll	If true, extracts all configuration data and not just customized configuration data.	No	false	Input
Version	Specifies the release of Oracle CRM On Demand for which configuration data is returned.	No	31	Input
apData:ListOfRelatedInformationLayout	The extracted related information layout data.	Not applicable	Not applicable	Output

Return Value of the Call

The related information layout data is returned.

RelatedInformationLayoutUpsert

Updates existing related information layout data or inserts new related information layout data.

Usage

Use the RelatedInformationLayoutUpsert method to insert or update related information layout data for an object.

The apdata:RelatedInformationLayout argument contains the following elements containing related information layout data:

• ObjectName. The name of the object.

• RelatedInformationName. A child object ID, equivalent to the name of a related information section. See Oracle Migration Tool On Demand Guide for reference tables about the mapping of child object IDs to UI display names for the child objects.

• Name. The name of the related information layout.

• Description. A description of the related information layout.

• SortField. The field used for sorting records. The <SortField> element is applicable for the following child objects only:

  • Assets, for all parent objects.

  • Contacts, for the Account parent object..

  • Opportunities, for the following parent objects: Account, Campaign, Contact, Custom Objects 01 through 03, Dealer, Objective, Opportunity child, and Partner Program.

  For the Assets child object, the valid values for the <SortField> element are:

  • Product Name.

  • Serial Number. Corresponds to the Serial # field. in the UI.

  • Product Status. Corresponds to the Status field in the UI..

  For the Contacts child object, the valid values for the <SortField> element are:

  • Last Name.

  • Primary Contact Flag. Corresponds to the Primary Contact check box. in the UI.

  For the Opportunities child object, the valid values for the <SortField> element are:

  • Primary Revenue Close Date. Corresponds to the Close Date field in the UI.

  • Created. Corresponds to the Created: Date field in the UI.

  • Name. Corresponds to the Opportunity Name field in the UI.

  • Updated. Corresponds to the Modified: Date field in the UI.

• SortDir. The sort order, which can be Ascending or Descending.

  The <SortDir> element is applicable for the following child objects only:

  • Assets, for all parent objects.

  • Contacts, for the Account parent object..

  • Opportunities, for the following parent objects: Account, Campaign, Contact, Custom Objects 01 through 03, Dealer, Objective, Opportunity child, and Partner Program.

• EnableListAdd. Whether the List Add feature is enabled (true) or is not enabled (false). Available for certain record types only. The List Add feature allows users to add multiple records to the related information section at one time.

• ListOfSelectedField. Contains all of the selected fields for the related information layouts. The field data for a particular related information layout is contained in the following child elements of <SelectedFieldData>:

  • FieldName. The name of the selected field. Required.

  • Sequence. An integer with the range of values 0 through 19, specifying the sequence of the field in the Selected Fields list.

See Oracle Migration Tool On Demand Guide for reference tables about the following:

• Mappings of object names to the display names for the objects in the Oracle CRM On Demand user interface.

Arguments

The following table describes the arguments taken by the RelatedInformationLayoutUpsert method.

Table Arguments Taken by the RelatedInformationLayoutUpsert Method

Name	Description	Required	Default	I/O
apData:RelatedInformationLayout	The related information layout to be inserted or updated.	Yes	Not applicable	Input
Status	The status of the call.	Not applicable	Not applicable	Output

Return Value of the Call

The status is returned.

ReportFolderRead

Extracts report and dashboard folder configuration data.

Usage

Use the ReportFolderRead method to read the details of a specified folder and its role associations. The following privileges are required:

• Manage Roles and Access.

• To read role associations for report folders: Manage Custom Reports.

• To read role associations for dashboard folders: Manage Dashboards.

• To read role associations for the V3 migrated company wide shared folders: Access Migrated Company Wide Shared Folder.

The <Path> child element of apQuery:ReportFolder is required to query folders containing reports or dashboards. You can query using only the <Path> element, but you can also include the <Catalog>, <FolderName>, and <ParentFolder> child elements.

If <Catalog> is not specified in the request, and the path exists in V3 catalogs, then results for V3 catalogs are returned.

For the folders in the Company Wide Shared Folder, the root folder is /shared/Company Analyses, and for the folders in the Migrated Company Wide Shared Folder, the root folder is /shared/Migrated Company Analyses.

You can query the root folder with the <Path> element as in the following example:

<quer:Path>/shared/Company Analyses</quer:Path>

To query for a specific subfolder, you use the <Path> element as in the following example:

<quer:Path>/shared/Company Analyses/Activity Book Visibility</quer:Path>.

where /shared/Company Analyses/Activity Book Visibility is the path to that particular folder.

See ReportFolderUpsert for information about the folder data specified in apData:ReportFolder.

Arguments

The following table describes the arguments taken by the ReportFolderRead method.

Table Arguments Taken by the ReportFolderRead Method

Name	Description	Required	Default	I/O
apQuery:ReportFolder	The folder query criteria.	Yes	Not applicable	Input
apData:ListOfReportFolder	The extracted folder data.	Not applicable	Not applicable	Output

Return Value of the Call

The folder configuration data is returned.

ReportFolderReadAll

Extracts all of the report and dashboard folder configuration data for a company.

Usage

Use the ReportFolderReadAll method to read the details of all folders and their role associations. The following privileges are required:

• Manage Roles and Access

• To read role associations for report folders: Manage Custom Reports.

• To read role associations for dashboard folders: Manage Dashboards.

• To read role associations for the V3 migrated company wide shared folders: Access Migrated Company Wide Shared Folder.

The input argument <Version> specifies the release of Oracle CRM On Demand for which configuration data is returned. The default value is 34, however, to return folders from the V3 catalog the value of <Version> must be 35 or higher.

ReportFolderReadAll returns folders, subfolders, and associated roles of all reports and dashboard folders from V3 catalogs namely:

• V3 Company Wide Shared Folder

• V3 Migrated Company Wide Shared Folder (only if your user role includes the Access Migrated Company Wide Shared Folder privilege).

See ReportFolderUpsert for information about the report folder data specified in apData:ReportFolder.

Arguments

The following table describes the arguments taken by the ReportFolderReadAll method.

Table Arguments Taken by the ReportFolderReadAll Method

Name	Description	Required	Default	I/O
Version	Specifies the release of Oracle CRM On Demand for which configuration data is returned	No	34	Input
apData:ListOfReportFolder	The extracted data for all folders.	Not applicable	Not applicable	Output

Return Value of the Call

The folder configuration data is returned.

ReportFolderUpsert

Updates or inserts role and access level information for a shared folder.

Usage

Use the ReportFolderUpsert method to insert or update role and access level information for a shared folder. The following privileges are required:

• Manage Roles and Access

• To update and insert role associations for report folders: Manage Custom Reports.

• To update and role associations for dashboard folders: Manage Dashboards.

• To update and insert role associations for the V3 migrated company wide shared folders: Access Migrated Company Wide Shared Folder.

ReportFolderUpsert can insert or update only the role and access level data for a report folder. It is not possible to insert or update any other report folder data. For upsert requests, <Path> is required.

The user keys for upsert operations are:

<Path>

<Path> + <Catalog>

If the <Catalog> element is not specified, and if multiple folders are found that match the value in the <Path> element, then an error is returned.

The root folder is read-only, so it is not possible to perform upserts for the root folder.

The apdata:ReportFolder argument contains the following elements containing report folder data:

• Catalog. The catalog version of the folder. The value must be V3 or blank (V3 is the default value.)

• Path. The path of the folder (required).

• FolderName. The name of the folder.

• ParentFolder. The parent folder. If the folder is created directly in the company-wide shared folder, then the name of the parent folder is Company Analyses.

• Description. A description of the folder.

• ListOfSubFolders. The subfolders:

• Catalog. The catalog version of the folder. The value must be V3 or blank (V3 is the default value).

  • Path. The path of the folder.

  • FolderName. The name of the subfolder.

  • Description. A description of the subfolder.

• ListOfAssociatedRoles. The role data:

  • RoleName. The name of the role.

  • AccessLevel. The access level: Read or Change/Delete.

Arguments

The following table describes the arguments taken by the ReportFolderUpsert method.

Table Arguments Taken by the ReportFolderUpsert Method

Name	Description	Required	Default	I/O
apData:ReportFolder	The report or dashboard folder data to be inserted or updated.	Yes	Not applicable	Input
Status	The status of the call.	Not applicable	Not applicable	Output

Return Value of the Call

The status is returned.

RoleRead

Extracts role configuration data.

Usage

Use the RoleRead method to extract role configuration data. The Manage Roles and Access privilege is required.

The role is specified with the <RoleName> child element of apQuery:Role.

See RoleUpsert for information about the role data specified in apData:Role.

Arguments

The following table describes the arguments taken by the RoleRead method.

Table Arguments Taken by the Role Read Method

Name	Description	Required	Default	I/O
apQuery:Role	The role query criteria.	Yes	Not applicable	Input
apData:ListOfRole	The extracted role data.	Not applicable	Not applicable	Output

Return Value of the Call

The roles for the object are returned.

RoleReadAll

Extracts all of the role configuration data for a company.

Usage

Use the RoleReadAll method to read all of the roles. The Manage Roles and Access privilege is required.

The input argument <Version> specifies the release of Oracle CRM On Demand for which configuration data is returned. The default value is 33, and specified values up to and including 33 return configuration data applicable to Oracle CRM On Demand Release 33.

If the value specified is greater than 33, then all of the configuration data up to the release specified is returned. For example, if a value of 34 is specified, then all of the configuration data in Release 33 plus the newer data up to Release 34 is returned.

See RoleUpsert for information about the role data specified in apData:Role.

Arguments

The following table describes the arguments taken by the RoleReadAll method.

Table Arguments Taken by the RoleReadAll Method

Name	Description	Required	Default	I/O
Version	Specifies the release of Oracle CRM On Demand for which configuration data is returned.	No	33	Input
apData:ListOfRole	The extracted data for all roles for all objects.	Not applicable	Not applicable	Output

Return Value of the Call

The roles are returned.

RoleUpsert

Updates an existing role or inserts a new role.

Usage

Use the RoleUpsert method to insert a role or update an existing role. The Manage Roles and Access privilege is required. The Manage Company privilege is required to update the <ExpirePasswordIn> element.

The role is specified with the <RoleName> element of apdata:Role.

The apdata:Role argument contains the following elements containing role data:

• RoleName. The name of the role. When performing an insert operation, this name is used as the display name, if a display name is not provided in the <RoleTranslation> element.

• Description. The role description.

• DefaultSalesProcess. The default sales process for new opportunities created by users who are assigned this role.

• ThemeName. The default theme for the role.

• ModernThemeName. The tablet theme for the role.

• LeadConversionLayout. The lead conversion layout for the users assigned this role.

• ActionBarLayout. The action bar layout for the users assigned this role.

• RelatedInfoFormat. The format for related information sections on record Detail pages, which can be shown as lists or as tabs.

• ExpirePasswordIn. The length of time for which the password of users assigned this role is valid. Possible values are: 30 days, 60 days, 90 days, 180 days, One Year, Never expires. If no value is specified, then the password expiry period that is defined for the company applies to users who have this role.

• LimitRecordsInListExport. The maximum number of records that users who have this role can export at one time when exporting a list of records through the Export List menu option on List pages. By default, no restriction is applied and this element is empty. This element corresponds to the Maximum Number of Records per List Export field in the UI.

  Note: If a maximum is specified, it applies only to exports that are performed through the Export List menu option on List pages. It does not apply to export operations that are performed through the Export Assistant or through any other channel.

• ListOfRoleTranslation. The role name in the languages activated for your company:

  • LanguageCode. The three-letter language code for the language.

  • RoleName. The role name in the language identified by the language code.

  • ActivityListOnCalendarView. The name of the activity list that is displayed in calendar pages for users who have this role, if an activity list is specified for the role.

• ListOfRecordTypeAccess. The record type access data:

  • RecordName. The record type.

  • HasAccess. Whether users assigned this role have access to records of this type.

  • CanCreate. Whether users assigned this role can create records of this type.

  • CanReadAll. Whether users assigned this role can see all records of this type.

• AccessProfile. The access profiles associated with the role:

  • DefaultAccessProfile. The default access profile.

  • OwnerAccessProfile. The owner access profile.

• ListOfPrivilege. The privileges associated with the role:

  • PrivilegeName. A privilege ID, equivalent to the name of a privilege in the Oracle CRM On Demand application. See Oracle Migration Tool On Demand Guide for reference tables about the mapping of privilege IDs to UI display names for the privileges.

  • Enabled. Whether the privilege is assigned to the role.

• TabAccessandOrder. The tabs available and selected for the role:

  • ListOfAvailableTab. The available tabs:

    • AvailableTab. The name of the tab.

  • ListOfSelectedTab. The selected tabs:

    • TabName. The name of the tab.

    • Order. The position in which the tab name appears in the Selected Tabs list. A value of 0 (zero) corresponds to the first tab in the Selected Tabs list.

• ListOfPageLayoutAssignment. The page layout assignment for each record type:

  • PageViewType. The page view type: Static or Dynamic.

  • RecordType. The record type.

  • LayoutName. The name of the page layout. If no name is specified, the default layout is applied.

• ListOfSearchLayoutAssignment. The search layout assignment for each record type:

  • RecordType. The record type.

  • LayoutName. The name of the search layout.

• ListOfHomepageLayoutAssignment. The homepage layout assignment for each record type:

  • RecordType. The record type.

  • LayoutName. The name of the homepage layout.

See Oracle Migration Tool On Demand Guide for reference tables about the following:

• Mappings of three-letter language codes to languages.

• Information on privilege IDs, and their corresponding names, and descriptions.

Arguments

The following table describes the arguments taken by the RoleUpsert method.

Table Arguments Taken by the Role Upsert Method

Name	Description	Required	Default	I/O
apData:Role	The role data to be inserted or updated.	Yes	Not applicable	Input
Status	The status of the call.	Not applicable	Not applicable	Output

Return Value of the Call

The status is returned.

SalesAssessmentTemplateRead

Extracts sales assessment template configuration data.

Usage

Use the SalesAssessmentTemplateRead method to extract sales assessment template configuration data matching the input criteria.

The sales assessment template is specified with the <Name> child element of apQuery:SalesAssessmentTemplate.

See SalesAssessmentTemplateUpsert for information about the sales assessment template data specified in apData:SalesAssessmentTemplate.

Arguments

The following table describes the arguments taken by the SalesAssessmentTemplateRead method.

Table Arguments Taken by the SalesAssessmentTemplateRead Method

Name	Description	Required	Default	I/O
apQuery:SalesAssessmentTemplate	The sales assessment template query criteria.	Yes	Not applicable	Input
apData:ListOfSalesAssessmentTemplate	The extracted sales assessment template data.	Not applicable	Not applicable	Output

Return Value of the Call

The sales assessment template is returned.

SalesAssessmentTemplateReadAll

Extracts all of the sales assessment template configuration data for a company.

Usage

Use the SalesAssessmentTemplateReadAll method to read all of the sales assessment templates.

See SalesAssessmentTemplateUpsert for information about the sales assessment template data specified in apData:SalesAssessmentTemplate. A number of fields that are used in the calculation of assessment scores and comparisons to thresholds are also returned.

Arguments

The following table describes the arguments taken by the SalesAssessmentTemplateReadAll method.

Table Arguments Taken by the SalesAssessmentTemplateReadAll Method

Name	Description	Required	Default	I/O
apData:ListOfSalesAssessmentTemplate	The extracted data for all sales assessment templates.	Not applicable	Not applicable	Output

Return Value of the Call

The sales assessment templates are returned.

SalesAssessmentTemplateUpsert

Updates an existing sales assessment template or inserts a new sales assessment template.

Usage

Use the SalesAssessmentTemplateUpsert method to insert a sales assessment template or update an existing sales assessment template.

The apdata:SalesAssessmentTemplate argument contains the following elements containing sales assessment template data:

• Name. The name for the sales assessment template (required).

• Active. Whether the sales assessment template is active.

• Filter. The filters used to identify which assessment script is the appropriate one to present to a user for a task.

• Description. A description for the sales assessment template.

• FieldtoMapScoreTo. The field that displays the score in the parent record.

• ResponseControl. The control used for adding responses to assessment questions. Possible values are: Drop Down, Radio Button.

• FieldtoMapOutcomeValueTo. The field that displays the outcome value in the parent record.

• RemoveCommentBox. Whether the comment box is removed when the user is completing the assessment.

• OutcomeValueIfThresholdMet. The outcome value to display if the threshold score is met.

• OutcomeValueIfThresholdNotMet. The outcome value to display if the threshold score is not met.

• ThresholdScore. The score used to calculate the outcome of the script. If the score is equal to or higher than the threshold, the outcome is met.

• Type. The type of assessment script (required). Possible values are:

  • Activity Assessment

  • Account Survey

  • Business Plan Assessment

  • Contact Script

  • Lead Qualification

  • Objective Assessment

  • Opportunity Assessment

  • Service Request - Script

  • Service Request - Survey

• ListOfSalesAssessmentTemplateAttribute. The attributes for the sales assessment template. The following are child elements of the SalesAssessmentTemplateAttributeData element:

  • Question. A question to be answered by the user (required).

  • CriteriaName. A descriptive name for the question (required).

  • AnswerMapToField. The field on the parent record for displaying the answer to the question.

  • Order. The position in the sequence of the questions presented to the user.

  • Weight. A percentage value indicating the importance of the question. The sum of the weights for all questions must equal 100 (required).

  • ListOfSalesAssessmentTemplateAttributeValue. The attribute values of the sales assessment template. The following are child elements of the element SalesAssessmentAttributeValueData:

    • Order. The position in the sequence of the answers presented to the user when completing the assessment.

    • Answer. An answer for the question (required).

    • Score. The score for the answer (required).

Arguments

The following table describes the arguments taken by the SalesAssessmentTemplateUpsert method.

Table Arguments Taken by the SalesAssessmentTemplateUpsert Method

Name	Description	Required	Default	I/O
apData:SalesAssessmentTemplate	The sales assessment template data to be inserted or updated.	Yes	Not applicable	Input
Status	The status of the call.	Not applicable	Not applicable	Output

Return Value of the Call

The status is returned.

SalesCategoryRead

Extracts sales stage category configuration data.

Usage

Use the SalesCategoryRead method to extract sales stage category configuration data matching the input criteria. The Manage Sales Stage Definition privilege is required.

The sales category is specified with the Order child element of apQuery:SalesCategorySet.

See SalesCategoryUpsert for information about the sales stage category data specified in apData:SalesCategory.

Arguments

The following table describes the arguments taken by the SalesCategoryRead method.

Table Arguments Taken by the SalesCategoryRead Method

Name	Description	Required	Default	I/O
apQuery:SalesCategorySet	The sales stage category query criteria.	Yes	Not applicable	Input
apData:ListOfSalesCategorySet	The extracted sales stage category data.	Not applicable	Not applicable	Output

Return Value of the Call

The sales stage category is returned.

SalesCategoryReadAll

Extracts all of the sales stage category configuration data for a company.

Usage

Use the SalesCategoryReadAll method to read all of the sales stage categories. The Manage Sales Stage Definition privilege is required.

See SalesCategoryUpsert for information about the sales stage category data specified in apData:SalesCategorySet.

Arguments

The following table describes the arguments taken by the SalesCategoryReadAll method.

Table Arguments Taken by the SalesCategoryReadAll Method

Name	Description	Required	Default	I/O
apData:ListOfSalesCategorySet	The extracted data for all sales stage categories.	Not applicable	Not applicable	Output

Return Value of the Call

The sales stage categories are returned.

SalesCategoryUpsert

Updates an existing sales stage category or inserts a new sales stage category.

Usage

Use the SalesCategoryUpsert method to insert a sales stage category or update an existing sales stage category. The Manage Sales Stage Definition privilege is required.

The apdata:SalesCategorySet argument contains the following elements containing sales stage category data:

• Order. The sequence of the sales stage category.

• StageCategory. The name of the sales stage category.

• Description. A description for the sales stage category.

• Mark for Translation. Whether the sales stage category data is translated.

• ListOfSalesCategoryTranslations. The sales stage category data in the languages activated for your company:

  • LanguageCode. The three-letter language code for the language.

  • StageCategory. The name of the sales stage category in the language identified by the language code.

  • Description. The description of the sales stage category in the language identified by the language code.

See Oracle Migration Tool On Demand Guide for reference tables about the following:

• Mappings of three-letter language codes to languages.

For more information about setting up sales stage categories, see Oracle CRM On Demand Online Help.

Arguments

The following table describes the arguments taken by the SalesCategoryUpsert method.

Table Arguments Taken by the SalesCategoryUpsert Method

Name	Description	Required	Default	I/O
apData:SalesCategorySet	The sales stage category data to be inserted or updated.	Yes	Not applicable	Input
Status	The status of the call.	Not applicable	Not applicable	Output

Return Value of the Call

The status is returned.

SalesProcessQueryPage

Extracts sales process information for one or more sales processes, depending on the search criteria that you specify.

Usage

Use the SalesProcessQueryPage method to retrieve sales process information including sales stages, order of the sales stages, default probability, and associated opportunity types.

The LisfOfSalesProcess argument contains elements for the various fields of a sales process, and for the associated opportunity types and sales stages. There are child elements <ListOfOpportunityType> and <ListOfSalesStage>. You can search for specific sales processes, by specifying search criteria in the child elements of <SaleProcess>. For example, you can search for the following:

• A specific sales process, by specifying the ID of the sales process, as follows: <Id>'Id to search'</Id>

• A specific sales process, by specifying the language-independent name of the sales process, as follows: <BaseName>='Name to search'</BaseName>

• All sales processes except the default sales process, by specifying the following: <Default>='N'</Default>

• The default sales process only, by specifying the following: <Default>='Y'</Default>

• All sales processes created after a certain date, for example: <CreatedDate>&gt;='2020-11-25T09:00:00Z'</CreatedDate>

If you do not specify any search criteria, then the information for all of the sales processes for the company is returned.

For most of the child elements of <ListOfSalesProcess>, you can use the sortorder and sortsequence attributes to specify how fields in the returned sales process information are sorted.

Note: The Name and Description fields of SalesProcess do not support the sort specification.

See SalesProcessInsertOrUpdate for information about the sales process data specified in <ListOfSalesProcess>.

Arguments

The following table describes the arguments taken by the SalesProcessQueryPage method.

Table Arguments Taken by the SalesProcessQueryPage Method

Name	Description	Required	Default	I/O
ListOfSalesProcess	The list of sales processes queried (input), and after query execution, the list of sales processes returned (output).	Yes	Not applicable	Input/Output
PageSize	The maximum number of records displayed on a page following a query.	No	10	Input
StartRowNum	Indicates the row from which the SalesProcessQueryPage method starts to return records. For example, if PageSize=100 and you want to return records 1-100, you set StartRowNum to 0. Then, if you want to return records 101-200, you set StartRowNum to 100, and run the query again. You continue doing this until the last page is returned. In this way, you can return all records for a particular query.	No	0	Input
recordcountneeded	Indicates whether a record count for the object is to be returned.	No	False	Input
searchspec	Indicates the search specification for a field or for all the fields of an object.	No	Not applicable	Input
sortsequence	An integer value that determines the order of the sort specification.	No	Not applicable	Input
sortorder	Determines the sort order for the records returned by the query, either ASC for ascending or DESC for descending.	No	ASC	Input
LOVLanguageMode	The language mode for picklists, see The LOVLanguageMode Argument.	No	LIC	Input
LastPage	A value that indicates whether or not the last value in the query set has been returned.	Not applicable	Not applicable	Output
recordcount	An integer value that indicates the record count for the object	Not applicable	Not applicable	Output

Return Value of the Call

The sales process data is returned.

SalesProcessInsertOrUpdate

Updates existing sales process configuration data or inserts new data.

Usage

Use the SalesProcessInsertOrUpdate method to update or insert sales process configuration data. The Manage Data Rules - Manage Sales Stage Definition privilege is required.

New sales processes are inserted and existing sales processes are updated. Sales processes that are not identified in the request are not affected.

The <BaseName> child element of apData:SalesProcess is used to identify sales process records in a request.

If no sales process is located using this criteria, then a sales process is inserted with the configuration specified in the request.

The ListOfSalesProcess argument contains the following elements in the <SalesProcess> element for each sales process:

• Id. The ID of the sales process.

• Name. The name of the sales process.

• Translate. Whether the sales process is marked for translation.

• Default. Whether this sales process is the default sales process.

• Description. The description of the sales process.

• TranslationLanguage. The three-letter code for the language.

• BaseName. The language-independent name of the sales process.

• ListOfOpportunityType. Information contained in the following elements in the <OpportunityType> element for each opportunity type:

  • Id. The ID of the opportunity type.

  • Type. The name of the opportunity type.

• ListOfSalesStage. Information contained in the following elements in the <SalesStage> element for each sales stage:

  • Id. The ID of the sales stage.

  • Name. The name of the sales stage.

  • SalesCategoryName. The category that the sales stage is associated with.

  • Order. The sequence of the sales stages as they appear in the picklist.

  • Probability. The default probability for the sales stage.

  • Description. The description of the sales stage.

  • TranslationLanguage. The three-letter code for the language.

  • BaseName. The language-independent name of the sales stage.

  • BaseCategoryName. The language-independent name of the sales category that the sales stage is associated with.

  Note: When a sales process is created, sales stages named Closed/Lost and Closed/Won are automatically associated with the sales process. The Probability field on the Closed/Lost sales stage is set to zero (0), and the Probability field on the Closed/Won sales stage is set to 100. You cannot change these values. Do not set up any other sales stage with the Probability field equal to 0 or 100 percent. Modifying picklists that are used internally by the Oracle CRM On Demand application can have an adverse impact on standard functionality. You cannot remove the Closed/Lost and Closed/Won sales stages from a sales process.

• ListOfTranslation. Information contained in the following elements in the <Translation> element for each language activated for your company:

  • Id. The ID of the sales stage.

  • LanguageId. The three-letter code for the translation language.

  • Description. The description of the sales process in the language identified by the language code.

  • Name. The name of the sales process in the language identified by the language code.

In addition, the following elements are also included in each of the <SalesProcess>, <OpportunityType>, <SalesStage>, and <Translation> elements:

• CreatedById. The Row ID of the user who created the instance (that is, the sales process, opportunity type, sales stage, or translation record).

• CreatedDate. The date and time the instance was created.

• CreatedBy. A combination of the full name of the person who created the instance, and the date on which the instance was created.

• ModId. The modification key, which helps to check and protect against concurrent updates.

• ModifiedById. The Row ID of the user who last modified the instance.

• ModifiedDate. The date and time the instance was last modified.

• ModifiedBy. A combination of the full name of the person who last modified the instance, and the date on which the instance was last modified.

Arguments

The following table describes the arguments taken by the SalesProcessInsertOrUpdate method.

Table Arguments Taken by the SalesProcessInsertOrUpdate Method

Name	Description	Required	Default	I/O
apData:SalesProcess	The sales process data to be updated or inserted.	Yes	Not applicable	Input
Status	The status of the call.	Not applicable	Not applicable	Output

Return Value of the Call

A status object of the apData:SalesProcess type that contains the following:

• Created. The username and time and date for the user who created the sales process.

• Modified. The username and time and date for the user who modified the sales process.

• Id. The ID of the sales process.

• ModId. The modification key, which helps to check and protect against concurrent updates.

SalesStageQueryPage

Extracts sales stage information for one or more sales stages, depending on the search criteria that you specify.

Usage

Use the SalesStageQueryPage method to retrieve sales stage information including additional required fields, process coach steps, automated tasks, and useful resources (file and URL attachments).

The ListOfSalesStage argument contains elements for the various fields of a sales stage, and for the associated process coach steps, automated tasks, attachments, and additional required fields. There are child elements <ListOfProcessCoach>, <ListOfAutomatedTask>, <ListOfTranslation>, <ListOfProcessCoachTranslation>, <ListOfAttachments>, <ListOfAutomatedTaskTranslation>, and <ListOfRequiredFields>. You can search for specific sales stages, by specifying search criteria in the child elements of <SaleStage>. For example, you can search for the following:

• A specific sales stage, by specifying the ID of the sales stage, as follows: <Id>'Id to search'</Id>

• A specific sales stage, by specifying the language-independent name of the sales stage, as follows: <BaseName>='Name to search'</BaseName>

  If there is more than one sales stage with the same name associated with different sales processes, then all of the sales stages with the specified name are returned, unless you also specify the language-independent name of the sales process that the sales stage is associated with in the <SalesProcessBaseName> element. You can use the SalesProcessQueryPage method to extract the language-independent names of the sales processes.

• All sales stages created after a certain date, for example: <CreatedDate>&gt;='2020-11-25T09:00:00Z'</CreatedDate>

If you do not specify any search criteria, then the information for all of the sales stages for the company is returned.

For most of the child elements of <ListOfSalesStage>, you can use the sortorder and sortsequence attributes to specify how fields in the returned sales stage information are sorted.

See SalesStageInsertOrUpdate for information about the sales stage data specified in <ListOfSalesStage>.

Arguments

The following table describes the arguments taken by the SalesStageQueryPage method.

Table Arguments Taken by the SalesStageQueryPage Method

Name	Description	Required	Default	I/O
ListOfSalesStage	The list of sales stages queried (input), and after query execution, the list of sales stages returned (output).	Yes	Not applicable	Input/Output
PageSize	The maximum number of records displayed on a page following a query.	No	10	Input
StartRowNum	Indicates the row from which the SalesStageQueryPage method starts to return records. For example, if PageSize=100 and you want to return records 1-100, you set StartRowNum to 0. Then, if you want to return records 101-200, you set StartRowNum to 100, and run the query again. You continue doing this until the last page is returned. In this way, you can return all records for a particular query.	No	0	Input
recordcountneeded	Indicates whether a record count for the object is to be returned.	No	False	Input
searchspec	Indicates the search specification for a field or for all the fields of an object.	No	Not applicable	Input
sortsequence	An integer value that determines the order of the sort specification.	No	Not applicable	Input
sortorder	Determines the sort order for the records returned by the query, either ASC for ascending or DESC for descending.	No	ASC	Input

Return Value of the Call

The sales stage data is returned.

SalesStageInsertOrUpdate

Updates existing sales stage configuration data or inserts new data.

Usage

Use the SalesStageInsertOrUpdate method to update or insert sales stage configuration data. The Manage Data Rules - Manage Sales Stage Definition privilege is required.

New sales stages are inserted and existing sales stages are updated. Sales stages that are not identified in the request are not affected.

The <BaseName> and <SalesProcessBaseName> child elements of apdata:SalesStage are used to identify sales stage records in a request.

If no sales stage is located using this criteria, then a sales stage is inserted with the configuration specified in the request.

Note: Sales stages named Closed/Lost and Closed/Won are automatically associated with each sales process. The Probability field on the Closed/Lost sales stage is set to zero (0), and the Probability field on the Closed/Won sales stage is set to 100. You cannot change these values. Do not set up any other sales stage with the Probability field equal to 0 or 100 percent. Modifying picklists that are used internally by the Oracle CRM On Demand application can have an adverse impact on standard functionality.

The ListOfSalesStage argument contains the following elements in the <SalesStage> element for each sales stage:

• Id. The ID of the sales stage.

• SalesCategoryId. The ID of the sales category that the sales stage is associated with.

• SalesCategoryName. The name of the sales category that the sales stage is associated with.

• SalesCategoryBaseName. The language-independent name of the sales category that the sales stage is associated with.

• Probability. The default probability for the sales stage.

• SalesProcessBaseName. The language-independent name of the sales process that the sales stage is associated with.

• BaseName. The language-independent name of the sales stage.

• Name. The name of the sales stage.

• Description. The description of the sales stage.

• Order. The sequence of the sales stage as it appears in the picklist.

• Status. The status of the sales stage.

• BaseDescription. The language-independent description of the sales stage.

• SalesProcessId. The ID of the sales process that the sales stage is associated with.

• Language. The three-letter code for the language.

• SalesProcessName. The name of the sales process that the sales stage is associated with.

• ListOfProcessCoach. Information contained in the following elements in the <ProcessCoach> element for each process coach step:

  • Id. The ID of the process coach step.

  • SalesStageId. The ID of the sales stage that the process coach step is associated with.

  • BaseTitle. The language-independent title of the process coach step.

  • Order. The sequence of the process coach step as it appears in the picklist.

  • BaseDescription. The language-independent description of the process coach step.

  • Language. The three-letter code for the language.

  • Title. The title of the process coach step.

  • Description. The description of the process coach step.

  • StepName. The name of the process coach step.

• ListOfAutomatedTask. Information contained in the elements in the <AutomatedTask> element for each automated task. There is a child element for each field that is available to be added to a task Detail page, including custom fields. For more information about task fields, see Activity.

• ListOfTranslation. Information contained in the following elements in the <Translation> element for each automated task that is translated:

  • Id. The ID of the translation record.

  • Description. The description of the sales stage in the language identified by the language code.

  • Language. The three-letter code for the translation language.

  • SalesStageId. The ID of the sales stage.

  • Name. The name of the sales stage in the language identified by the language code.

• ListOfProcessCoachTranslation. Information contained in the following elements in the <ProcessCoachTranslation> element for each language activated for your company:

  • Id. The ID of the translation record.

  • Language. The three-letter code for the language.

  • Title. The title of the process coach step in the language identified by the language code.

  • Instruction. The description of the process coach step in the language identified by the language code.

  • ProcessCoachId. The ID of the process coach step.

  • ProcessCoachName. The name of the process coach step in the language identified by the language code.

  • SalesStageId. The ID of the sales stage that the process coach step is associated with.

• ListOfAttachment. Information contained in the following elements in the <Attachment> element for each attachment:

  • Id. The ID of the attachment.

  • AttachmentTag. Indicates whether the attachment is a file or a URL.

  • SalesStageId. The ID of the sales stage that the attachment is associated with.

  • FileExtension. The file extension of the attachment, if the attachment is a file.

  • DisplayFileName. The display name for the attachment.

  • FileDate. The date the file was uploaded, if the attachment is a file.

  • Description. The description of the attachment.

  • FileSize. The size of the file in KB, if the attachment is a file. The maximum file size for an attachment is 20 MB.

  • FileNameOrURL. The name of the file or the URL string.

  • Attachment. The file to be attached, if the attachment is a file.

    Note: When you extract sales stage information, the content of any attached files is included, encoded as inline Base64 encoded data. For more information about file attachments, see Using Attachments with Web Services On Demand.

• ListOfAutomatedTaskTranslation. Information contained in the following elements in the <AutomatedTaskTranslation> element for each automated task that is translated:

  • Id. The ID of the translation record.

  • Subject. The subject of the task in the language identified by the language code.

  • TaskId. The ID of the task.

  • Language. The three-letter code for the translation language.

  • SalesStageId. The ID of the sales stage that the task is associated with.

  • TaskExternalSystemId. The unique external ID of the task.

  • TaskIntegrationId. The integration ID of the task.

  • Comments. The description of the task in the language identified by the language code.

• ListOfRequiredField. Information contained in the following element in the <RequiredField> element for each field that is specified as a required field for the sales stage:

  • Id. The ID of the field.

  • DefaultValue. The default value for the field.

  • FieldName. The name of the field.

  • TagName. The integration tag for the field.

In addition, the following elements are also included in each of the <SalesStage>, <ProcessCoach>, <AutomatedTask>, <Translation>, <ProcessCoachTranslation>, <Attachment>, <AutomatedTaskTranslation>, and <RequiredFields> elements:

• ModifiedDate. The date and time the instance (that is, the sales stage, process coach step, automated task, attachment, required field, or translation of a task or process coach step) was last modified.

• CreatedDate. The date and time the instance was created.

• ModifiedById. The Row ID of the user who last modified the instance.

• CreatedById. The Row ID of the user who created the instance.

• ModId. The modification key, which helps to check and protect against concurrent updates.

• UpdatedByFirstName. The first name of the user who last modified the instance.

• UpdatedByLastName. The last name of the user who last modified the instance.

• UpdatedByUserSignInId. The sign-in ID of the user who last modified the instance.

• UpdatedByAlias. The alias of the user who last modified the instance.

• UpdatedByFullName. The full name of the user who last modified the instance.

• UpdatedByIntegrationId. The integration ID of the user who last modified the instance.

• UpdatedByExternalSystemId. The unique external ID of the user who last modified the instance.

• UpdatedByEmailAddr. The email address of the user who last modified the instance.

• CreatedBy. A combination of the full name of the person who created the instance, and the date on which the instance was created.

• CreatedByFirstName. The first name of the user who created the instance.

• CreatedByLastName. The last name of the user who created the instance.

• CreatedByUserSignInId. The sign-in ID of the user who created the instance.

• CreatedByAlias. The alias of the user who created the instance.

• CreatedByFullName. The full name of the user who created the instance.

• CreatedByIntegrationId. The integration ID of the user who created the instance.

• CreatedByExternalSystemId. The unique external ID of the user who created the instance.

• CreatedByEmailAddr. The email address of the user who created the instance.

• CreatedBy. A combination of the full name of the person who created the instance, and the date on which the instance was created.

• ModifiedBy. A combination of the full name of the person who last modified the instance, and the date on which the instance was last modified.

Arguments

The following table describes the arguments taken by the SalesStageInsertOrUpdate method.

Table Arguments Taken by the SalesProcessInsertOrUpdate Method

Name	Description	Required	Default	I/O
apData:SalesStage	The sales stage data to be updated or inserted.	Yes	Not applicable	Input
Status	The status of the call.	Not applicable	Not applicable	Output

Return Value of the Call

A status object of the apData:SalesStage type that contains the following:

• Created. The username and time and date for the user who created the sales stage.

• Modified. The username and time and date for the user who modified the sales stage.

• Id. The ID of the sales stage.

• ModId. The modification key, which helps to check and protect against concurrent updates.

SearchLayoutRead

Extracts all of the configuration data for a search layout for an object.

Usage

Use the SearchLayoutRead method to read the search layout data for an object.

The object and layout are specified with the <ObjectName> and <LayoutName> child elements of <apQuery:SearchLayout>. Only fields included in the request are returned in the response.

See SearchLayoutUpsert for information about the search layout data specified in apData:ListOfSearchLayout.

Arguments

The following table describes the arguments taken by the SearchLayoutRead method.

Table Arguments Taken by the SearchLayoutRead Method

Name	Description	Required	Default	I/O
apQuery:SearchLayout	The search layout query criteria.	Yes	Not applicable	Input
apData:ListOfSearchLayout	The extracted search layout data.	Not applicable	Not applicable	Output

Return Value of the Call

The search layout is returned.

SearchLayoutReadAll

Extracts all of the search layout configuration data for a company.

Usage

Use the SearchLayoutReadAll method to read all of the search layout data.

The input argument <Version> specifies the release of Oracle CRM On Demand for which configuration data is returned. The default value is 33, and specified values up to and including 33 return configuration data applicable to Oracle CRM On Demand Release 33.

If the value specified is greater than 33, then all of the configuration data up to the release specified is returned. For example, if a value of 34 is specified, then all of the configuration data in Release 33 plus the newer data up to Release 34 is returned.

See SearchLayoutUpsert for information about the search layout data specified in apData:ListOfSearchLayout.

Arguments

The following table describes the arguments taken by the SearchLayoutReadAll method.

Table Arguments Taken by the SearchLayoutReadAll Method

Name	Description	Required	Default	I/O
Version	Specifies the release of Oracle CRM On Demand for which configuration data is returned.	No	33	Input
apData:ListOfSearchLayout	The extracted search layout data.	Not applicable	Not applicable	Output

Return Value of the Call

The search layouts are returned.

SearchLayoutUpsert

Updates existing search layout data or inserts new search layout data.

Usage

Use the SearchLayoutUpsert method to insert or update search layout data.

The apdata:SearchLayout argument contains the following elements containing search layout data:

• ObjectName. The name of the object (required).

• LayoutName. The name of the search layout, which must be unique for an object (required).

• LastUpdatedBy. The date and time the layout was last updated.

• Description. A description of the search layout.

• ListOfSpecifySearchFields. Contains all of the fields specified for the search, corresponding to Step 2 in the Search Layout wizard in the UI. The field data is contained in the following child elements of <SearchLayoutField>:

  • FieldName. The system name of the field.

  • SearchOptimization. An integer value as follows (read-only):

    • -1. The field is not optimized for search and is always case sensitive (default text color in UI).

    • 1. The field is optimized for fast search and is always case sensitive (green in UI).

    • 2. The field is optimized for fast search and becomes case-insensitive when the Case Insensitive check box is selected in a search (blue in UI).

    • 3. The field is case-insensitive regardless of the Case insensitive check box and is not optimized for fast search (purple in UI).

  • Section. An integer identifying the section of the search layout in which the field appears:

    • 0. Not Available Search Fields.

    • 1. Targeted Search Fields.

    • 2. Additional Search Fields.

  • Order. The order of the field within the section, starting with 0 for the field at the top of the section. For the Not Available Search Fields section, where the fields are not ordered, all values for fields are -1.

• ListOfDefaultSearchValues. Contains all of the default values for the fields in the list of targeted search fields, corresponding to Step 3 in the Search Layout wizard in the UI. The field data is contained in the following child elements of <DefaultSearchField>:

  • FieldName. The system name of the field (read-only), which you can use as a user key. You can use the FieldManagementRead method to obtain the system name of the field.

  • DefaultSearchValue. The default value for the field. The condition for a default search value depends on the field type and you cannot specify a different condition for most of the field types. However, for fields of the Check Box type, the value you specify in the <DefaultSearchValue> corresponds to a condition and you can specify either Is Checked, which is the default condition, or Is Not Checked.

• DefaultSearchValueAssocId. The association ID (row ID) for a filter value for association control fields.

• ListOfDefineSearchResultsLayout. Contains all of the fields specified for the search results, corresponding to Step 4 in the Search Layout wizard in the UI. The field data is contained in the following child elements of <SearchLayoutField>:

• FieldName. The system name of the field.

• SearchOptimization. An integer value as follows (read-only):

  • -1. The field is not optimized for search and is always case sensitive (default text color in UI).

  • 1. The field is optimized for fast search and is always case sensitive (green in UI).

  • 2. The field is optimized for fast search and becomes case-insensitive when the Case Insensitive check box is selected in a search (blue in UI).

  • 3. The field is case-insensitive regardless of the Case insensitive check box and is not optimized for fast search (purple in UI).

• Section. An integer identifying the section of the search results in which the field appears.

  • 0. Not Available Search Results Fields.

  • 1. Lookup Window Search Results Fields.

  • 2. Additional Search Results Fields.

• Order. The order of the field within the section, starting with 0 for the field at the top of the section. For the Not Available Search Fields section, where the fields are not ordered, all values for fields are -1.

• EnableDivisionAsDefaultSearchField. Whether the search layout for the Product record type lists products by division. Corresponds to the Configure Lookup Window with Division as the Default Search Field check box in the UI.

• EnableDefaultFields. Whether default search fields are used for the Lookup window. Corresponds to the Configure Lookup Window With Default Fields check box in the UI.

• EnableDefaultSearchResults. Whether the list of available records is displayed in the Lookup window for the object when it is opened. Corresponds to the Show Search Results When Lookup Window Opens check box in the UI.

• EnableAutoResolve. Whether smart associations are enabled. Corresponds to the Auto-Resolve Enabled check box in the UI.

• EnableDefaultCtxSensitiveList. Whether context sensitive lists appear before the other lists in the record type List field in the upper-left corner of the Lookup window. Corresponds to the Show Context-Sensitive List as Lookup Window Default check box in the UI.

• EnableKeywordSearch. Whether the results page for enhanced keyword search displays the set of fields defined in the search layout. Corresponds to the Configure Enhanced Keyword Search with Selected Search Results Fields check box in the UI.

• EnableFirstTargetedFieldAsLookupDefault. Whether the first field in the list of targeted search fields in the search layout is used as the default search field in the Lookup window. Corresponds to the First Targeted Search Field as Default Search in Lookups check box in the UI.

• RestrictSearchToFieldsSelectedInRelatedInformationLayout.Whether the search is restricted to fields in the related information layout for the object. In certain cases, this setting is not considered. For more information about these cases, see Oracle CRM On Demand Online Help.

• EnableDefaultSort. Whether the default sort field is automatically selected in the New List and Advanced Search pages for a record type for a given role. Corresponds to the Auto-Populate Sort Field in New List and Advanced Search field in the UI.

See Oracle CRM On Demand Online Help for more information about searching and managing search layouts in Oracle CRM On Demand.

See Oracle Migration Tool On Demand Guide for reference tables about the mappings of object names to the display names for the objects in the Oracle CRM On Demand user interface.

Arguments

The following table describes the arguments taken by the SearchLayoutUpsert method.

Table Arguments Taken by the SearchLayoutUpsert Method

Name	Description	Required	Default	I/O
apData:SearchLayout	The search layout data to be inserted or updated.	Yes	Not applicable	Input
Status	The status of the call.	Not applicable	Not applicable	Output

Return Value of the Call

The status is returned.

SSOTokenRead

Provides an SSO token to a Web services client.

Usage

Use the SSOTokenRead method to request an SSO token that can be passed to the authentication servlet of Oracle CRM On Demand’s Web application server to create an interactive session.

As an example of usage, the SSO Token service can provide a token that Web service applications use to create a session on the interactive server, and then request analytics reports or capture screen HTML. Requesting a token in this way is more secure than storing tokens in memory for entire sessions, and more convenient than prompting the user to re-enter credentials when making a UI request. For better performance, Web service applications should explicitly log off interactive sessions when they are done with them.

Arguments

The following table describes the arguments taken by the SSOTokenRead method.

Table Arguments Taken by the SSOToken Read Method

Name	Description	Required	Default	I/O
apQuery:SSOTokenQuery	The SSO token query.	Yes	Not applicable	Input
apData:SSOTokenData	The extracted SSO token.	Not applicable	Not applicable	Output

Return Value of the Call

The SSO token is returned.

WorkflowActionSetRead

Extracts workflow action configuration data.

Usage

Use the WorkflowActionSetRead method to extract a workflow action set associated with a workflow rule.

The workflow rule is specified with the <WorkflowName> child element of apQuery:WorkflowActionsSet. If only <WorkflowName> is specified, all workflow action sets are returned.

If the value of <Version> is 31 or higher:

• You can read individual workflow actions by specifying a values for the <Name> element of apQuery:WorkflowActionQuery.

• You can read all the active workflow actions by specifying the <Active> element of apQuery:WorkflowActionQuery.

• You can use the child elements of <WorkflowEmailTranslation> to read the translations of the email subject and message body for the Send Email workflow action, for each language activated for your company, and if translations are available. For more information about the Send Email action, see Oracle CRM On Demand Online Help.

• You can use the <BookExpr> and <ReplaceBookExpr> child elements of WorkflowAssignBookAction to specify books assigned using the Assign a Book workflow action.

• The <Order> element is returned for each workflow action. For each workflow action, the <Name> and <Active> elements are also returned, otherwise only fields included in the request are returned.

See WorkflowActionSetUpsert for information about the workflow action data specified in apQuery:WorkflowActionSet.

Arguments

The following table describes the arguments taken by the WorkflowActionSetRead method.

Table Arguments Taken by the WorkflowActionSetRead Method

Name	Description	Required	Default	I/O
apQuery:WorkflowActionSet	The workflow action query criteria.	Yes	Not applicable	Input
apData:ListOfWorkflowActionSet	The extracted workflow action data.	Not applicable	Not applicable	Output

Return Value of the Call

The workflow action data is returned.

WorkflowActionSetReadForRuleSet

Extracts workflow action configuration data for a workflow rule set.

Usage

Use the WorkflowActionSetReadForRuleSet method to extract all the workflow action sets for a workflow rule set for a particular record type and trigger event.

The workflow rule set is specified with the following elements of <WorkflowActionForRuleSet>:

• RecordType. The record type (required).

• TriggerEvent. The event that triggers the workflow rule (required). The possible values and the associated trigger events are as follows:

Trigger Event	TriggerEvent LIC
When New Record Saved	WriteRecordNew
When Modified Record Saved	WriteRecordUpdated
Before Modified Record Saved	PreWriteRecord
Before Record Is Deleted	PreDeleteRecord
After Association With Parent	Associate
After Dissociation From Parent	Dissociate
When Record Is restored	RestoreRecord
When Records are merged	MergeRecords

• ParentRecordType. The parent record type. This is specified if the trigger event is After Association With Parent or After Dissociation From Parent. These trigger events are supported only for the Account, Contact, and Opportunity record types.

• Version. The release of Oracle CRM On Demand for which configuration data is extracted. The default value is 30, so to extract Release 31 or later functionality, you must specify a higher value than 30.

If the value of the <Version> element is 31 or higher:

• The child elements of <WorkflowEmailTranslation> containing translations of the email subject and message body for the Send Email workflow action, for each language activated for your company are returned, if available. For more information about the Send Email action, see Oracle CRM On Demand Online Help.

• The <BookExpr> and <ReplaceBookExpr> child elements of WorkflowAssignBookAction specifying books assigned using the Assign a Book workflow action are returned.

• The <Order> element is returned for each workflow action.

See WorkflowActionSetUpsert for information about the workflow action data specified in apQuery:WorkflowActionSet.

Arguments

The following table describes the arguments taken by the WorkflowActionSetReadForRuleSet method.

Table Arguments Taken by the WorkflowActionSetReadForRuleSet Method

Name	Description	Required	Default	I/O
apQuery:WorkflowActionForRuleSet	The workflow action query criteria.	Yes	Not applicable	Input
apData:ListOfWorkflowActionSet	The extracted workflow action data.	Not applicable	Not applicable	Output

Return Value of the Call

The workflow action sets are returned.

WorkflowActionSetUpsert

Updates existing workflow action configuration data or inserts new data.

Note: It is recommended that you use the WorkflowActionSetInsertOrUpdate method rather than the WorkflowActionSetUpsert method.

Usage

Use the WorkflowActionSetUpsert method to update or insert workflow action configuration data. The Manage Workflow Rules privilege is required.

New workflow action sets are inserted. Existing workflow action sets are updated, but existing workflow action sets that are not in the request are deleted.

The workflow action set is specified by the apData:WorkflowActionSet argument, and the associated workflow rule is specified with the <WorkflowName> child element of apData:WorkflowActionsSet.

The <Version> child element specifies the release of Oracle CRM On Demand for which configuration data is included. The default value is 30, so to include Release 31 or later functionality, you must specify a higher value than 30.

The workflow action set is specified by the <ListOfWorkflowActions> element, which has a <WorkflowAction> element for each action. Each action is specified by the following elements and a set of elements depending on the type of action:

• Name. The name of the action.

• Active. Whether the action is active.

• Order. The order number for the action within the set of actions.

The following child elements of <WorkflowAction> specify the data for the various types of action:

• WorkflowCreateTaskAction. The Create Task action:

  • Owner. The owner for the task (required). The value of this element depends on the <OwnerType> element, as follows:

    • If <OwnerType> is set to U (Specific User), then the <Owner> element contains the name of the user.

    • If the <OwnerType> element is set to R (Relative User On Record), then the value of the <Owner> element is defined. For possible values, see Oracle Migration Tool On Demand Guide

  • OwnerType. The type of owner (required). <OwnerType> corresponds to the Owner field in the UI. Valid values are:

    • R. Corresponds to the Relative User on Record option in the UI.

    • U. Corresponds to the Specific User option in the UI.

  • Type. The activity type.

  • SubType. The activity subtype.

  • DueDate. The due date for the task (required).

  • Priority. The activity priority (required). Pre-configured values are: 1 - High, 2 - Medium, 3 - Low.

  • Status. The activity status.

  • TaskCurrency. The three-character currency code.

  • Private. Whether the task is visible only to the task owner.

  • Subject. The subject line of the task (required).

  • Description. The description of the task.

• WorkflowAssignBookAction. The Assign a Book action:

  • BookName. The name of the book.

  • BookExpr. An expression for a book.

  • AssignmentOption. The assignment option (required): Add, Replace Type, Replace All, Replace Book, Remove, or Remove All.

  • ReplaceBookName. The name of the book to be replaced, if Replace Book is specified for <AssignmentOption>.

  • ReplaceBookExpr. An expression for the book to be replaced.

  • ApplyTo. How the assignment option is to be applied (required): Manual Associations, Automatic Associations, or Both.

  For the Assign a Book action, if both a book name and an expression are specified in the request, then only the book name is saved. Therefore, if you want to set up an Assign a Book action using an expression instead of the book name, you must make sure that only the expression field is populated.

• WorkflowSyncOwnerPartnerAction. The Sync Owner Partner action.

• WorkflowSyncBookPartnerAction. The Sync Book Partner action.

• WorkflowSyncPartnerBooksAction. The Sync Partner Books action.

• WorkflowCreateIntegrationEventAction. The Create Integration Event action:

  • ListOfQueues. The queues to which the integration events are written.

    • QueueName. The queue name (required).

  • ListOfFields. The fields tracked by the Create Integration Event action.

    • FieldName. The system name of the field (required).

    • AlwaysInclude. Whether the field is included in the integration event, even if the value of the field has not been changed.

    • TrackChanges. Whether an integration event is generated each time the field is updated.

  • SchemaVersion. The Web service schema version that is to be used for the integration events. Web Services v2.0 is the default value.

• WorkflowFieldUpdateAction. The Update Values action:

  • FieldName. The system name of the field (required).

  • Value. The new value for the field.

  • OverwriteExistingValues. Whether the existing value in the field is to be overwritten with the new value.

• WorkflowWaitAction. The Wait action:

  • ReevaluateRuleConditionsAfterWait. Whether Oracle CRM On Demand reevaluates the rule conditions after the wait period ends.

  • WaitType. The duration of wait (required). Valid values are: Period, Period Expression, Date Time, or Date Time Expression.

  • DateTime. The date and time if <WaitType> specifies Date Time.

  • WaitExpression. An expression if <WaitType> specifies Period Expression or Date Time Expression. When the <WaitType> value is Period, the <WaitExpression> element indicates a period based on the value PYMDTHM. For example:

    • PYM10DTHM indicates 10 days.

    • P1Y3MDTHM indicates 1 year and 3 months.

    • PYMDT5H15M indicates 5 hours and 15 minutes.

• WorkflowSendEmailAction. The Send Email action:

  • FromType. The type of sender email address (required). <FromType> corresponds to the From field in the UI. Valid values are:

    • FROM_EMAIL_ADDRESS. Corresponds to the Current User option in the UI.

    • FROM_DEFAULT. Corresponds to the Default Email Address option in the UI.

    • SPECIFIC_EMAIL_ADDRESS. Corresponds to the Specific Email Address option in the UI.

  • From. The email address, if SPECIFIC_EMAIL_ADDRESS is specified for <FromType>.

  • ReplyToType. The source of the email address that automatically appears in the To field when an email recipient replies to the email. <ReplyToType> corresponds to the Reply To field in the UI. Valid values are:

    • CURRENT_USER_ADDRESS. Corresponds to the Current User option in the UI.

    • SPECIFIC_EMAIL_ADDRESS. Corresponds to the Specific Email Address option in the UI.

    If this field is left empty, then the From address in the email appears in the To field in the email response.

  • ReplyTo. The email reply address, if SPECIFIC_EMAIL_ADDRESS is specified for <ReplyToType>.

  • ToType. The type of the recipient for the email (required). <ToType> corresponds to the To field in the UI. Valid values are:

    • R. Corresponds to the Relative User on Record option in the UI.

    • U. Corresponds to the Specific User option in the UI.

    • E. Corresponds to the Specific Email Address option in the UI.

  • To. The recipient for the email, The value of this element depends on the value in the <ToType> element, as follows:

    • If <ToType> is set to U (Specific User), then the <To> element contains the User ID of the user.

    • If <ToType> is set to R (Relative User on Record), then the value of the <To> element is defined. For possible values, see Oracle Migration Tool On Demand Guide

    • If <ToType> is set to E (Specific Email Address), then the <To> element contains the expression defined for specific email addresses.

  • Subject. The subject of the email (required).

  • EmailFormat. The format of the email, which can be Plain Text or HTML.

  • MessageBody. The message body (required). If you select HTML as the email format, you must enclose the HTML code in a CDATA section. Any unsupported elements are removed from the HTML. Refer to Oracle CRM On Demand Online Help for a list of the HTML elements that are allowed in the message body.

  • ContentType. For workflow rules where <RecordType> is Analytics and <TriggerEvent> is ScheduledEvent only, the type of Analytics object to execute. Possible values are Analysis, Dashboard, and Dashboard Page. For more information about creating scheduled events for the Analytics record type and configuring one or more Send Email actions on the event, see Oracle CRM On Demand Online Help.

  • ContentFormat. For workflow rules where <RecordType> is Analytics and <TriggerEvent> is ScheduledEvent only, the type of output to generate. Possible values depend on the value of <ContentType> as follows:

    • Analysis. CSV, MHTML, PDF, and XLSX.

    • Dashboard. XLSX.

    • Dashboard Page. PDF and XLSX.

  • SendEmailIfNoResults. For workflow rules where <RecordType> is Analytics, <TriggerEvent> is ScheduledEvent, and <ContentType> on the workflow action is Analysis, whether an email is to be sent (Y) or not to be sent (N) to a user if the analysis returns no results for that user.

  • ContentPath. For workflow rules where <RecordType> is Analytics and <TriggerEvent> is ScheduledEvent only, the path for the Analytics object.

  • Parameters. For workflow rules where <RecordType> is Analytics and <TriggerEvent> is ScheduledEvent only, the parameters for the Analytics object. The parameter syntax is validated when you insert or update. For more information about specifying parameters, see Oracle CRM On Demand Online Help.

  • ListOfWorkflowEmailTranslations. The email subject and message bodies in the languages activated for your company.

    • LanguageCode. The three-letter language code for the language.

    • SubjectTranslation. The subject of the email in the language identified by the language code.

    • MessageBodyTranslation. The message body in the language identified by the language code.

    If you update the email subject and message body in the default company language through a Web services call, the Mark for Translation check box in the Workflow Action Edit page in the UI is automatically selected. The default company language is then used for the subject and message body for each translated language, unless you also provide translations for the language in the same Web services call.

• WorkflowSubmitCallAction. The Submit Call action.

• WorkflowSubmitTransactionAction. The Submit action for submitting sample transactions.

For more information about workflow rules and actions, see Oracle CRM On Demand Online Help.

The Submit Call and Submit action for submitting sample transactions are available only in Oracle CRM On Demand Life Sciences Edition. Note that there is no data associated with the <WorkflowSubmitCallAction> or <WorkflowSubmitTransactionAction> elements. For more information about the Submit Call action and how you can use it, see Oracle CRM On Demand Disconnected Mobile Sales Administration Guide on Oracle Help Center. For more information about the Submit action for submitting sample transactions, see Oracle CRM On Demand Online Help.

The following workflow actions are available only in Oracle CRM On Demand for Partner Relationship Management:

• Sync Partner Books

• Sync Book Partner

• Sync Owner Partner

There is no data associated with the elements for these actions. For more information on these actions and how you can use them, see Oracle CRM On Demand for Partner Relationship Management Configuration Guide, available from the Oracle CRM On Demand documentation library.

Arguments

The following table describes the arguments taken by the WorkflowActionSetUpsert method.

Table Arguments Taken by the WorkflowActionSetUpsert Method

Name	Description	Required	Default	I/O
apData:WorkflowActionSet	The workflow action data to be updated or inserted.	Yes	Not applicable	Input
Status	The status of the call.	Not applicable	Not applicable	Output

Return Value of the Call

The status is returned.

WorkflowActionSetInsertOrUpdate

Updates existing workflow action configuration data or inserts new data.

Note: It is recommended that you use the WorkflowActionSetInsertOrUpdate method rather than the WorkflowActionSetUpsert method.

Usage

Use the WorkflowActionSetInsertOrUpdate method to update or insert workflow action configuration data.

New workflow actions are inserted and existing workflows actions are updated. Workflow actions that are not identified in the request are not affected. This is in contrast with the WorkflowActionSetUpsert method, which deletes workflow actions not identified in the request.

The <WorkflowName> and <Order> child elements of apData:WorkflowActionSet are used to identify workflow action records in a request.

If no workflow action is located using these criteria, a new workflow action is inserted with the configuration specified in the request.

See WorkflowActionSetUpsert for information about the workflow action data specified in apData:WorkflowActionSet.

For more information about workflow actions, see Oracle CRM On Demand Online Help.

Arguments

The following table describes the arguments taken by the WorkflowActionSetInsertOrUpdate method.

Table Arguments Taken by the WorkflowActionSetInsertOrUpdate Method

Name	Description	Required	Default	I/O
apData:WorkflowActionSet	The workflow action data to be updated or inserted.	Yes	Not applicable	Input
Status	The status of the call.	Not applicable	Not applicable	Output

Return Value of the Call

The status is returned.

WorkflowRuleSetDelete

Deletes workflow rule configuration data.

Usage

Use the WorkflowRuleSetDelete method to delete workflow rules and the associated workflow action configuration data. The Manage Workflow Rules privilege is required.

You can delete workflow rule sets by specifying values for the <RecordType>, <TriggerEvent>, and <ParentRecordType> child elements of apQuery:WorkflowRuleSet. You can specify the following combinations of elements:

• <WorkflowName>

• <WorkflowName> and <RecordType>

• <WorkflowName> and <TriggerEvent>

• <WorkflowName> and <RecordType> and <TriggerEvent>

• <WorkflowName> and <RecordType> and <TriggerEvent> and <ParentRecordType>

• <RecordType> and <TriggerEvent>

You can delete an individual workflow rule by specifying a value for <WorkflowName>. Upon deletion of a workflow rule, the other workflow rules in the set are re-ordered accordingly.

When <WorkflowName>, <RecordType> and <TriggerEvent> are all specified for a delete request, only records that match all three values are deleted.

See WorkflowRuleSetUpsert for information about the workflow rule data specified in apQuery:WorkflowRuleSet.

Arguments

The following table describes the arguments taken by the WorkflowRuleSetDelete method.

Table Arguments Taken by the WorkflowRuleSetDelete Method

Name	Description	Required	Default	I/O
apQuery:WorkflowRuleSet	The workflow rule set.	Yes	Not applicable	Input
Status	The status of the call.	Not applicable	Not applicable	Output

Return Value of the Call

The status is returned.

WorkflowRuleSetRead

Extracts workflow rule configuration data.

Usage

Use the WorkflowRuleSetRead method to extract workflow rule configuration data.

You can read workflow rule sets by specifying the <RecordType>, <TriggerEvent>, and <ParentRecordType> child elements of apQuery:WorkflowRuleSet.

You can read an individual workflow rule by specifying a value for the <WorkflowName> element.

The <Order> element is returned for each workflow rule, otherwise only fields included in the request are returned.

See WorkflowRuleSetUpsert for information about the workflow rule data specified in apData:WorkflowRuleSet.

Arguments

The following table describes the arguments taken by the WorkflowRuleSetRead method.

Table Arguments Taken by the WorkflowRuleSetRead Method

Name	Description	Required	Default	I/O
apQuery:WorkflowRuleSet	The workflow rule query criteria.	Yes	Not applicable	Input
apData:ListOfWorkflowRuleSet	The extracted workflow rule data.	Not applicable	Not applicable	Output

Return Value of the Call

The workflow rules data is returned.

WorkflowRuleSetReadAll

Extracts all of the workflow rule configuration data for a company.

Usage

Use the WorkflowRuleSetReadAll method to read all of the workflow rule sets.

The input argument <Version> specifies the release of Oracle CRM On Demand for which configuration data is returned. The default value is 28, and specified values up to and including 28 return configuration data applicable to Oracle CRM On Demand Release 28.

If the value specified is greater than 28, then all of the configuration data up to the release specified is returned. For example, if a value of 29 is specified, then all of the configuration data in Release 28 plus the newer data up to Release 29 is returned. See WorkflowRuleSetUpsert for information about the workflow rule data specified in apData:WorkflowRuleSet.

Elements applicable to the Scheduled Event trigger event are only returned if the input argument <Version> has a value of 37 or higher.

The <Order> element is returned for each workflow rule.

Arguments

The following table describes the arguments taken by the WorkflowRuleSetReadAll method.

Table Arguments Taken by the WorkflowRuleSetReadAll Method

Name	Description	Required	Default	I/O
Version	Specifies the release of Oracle CRM On Demand for which configuration data is returned.	No	28	Input
apData:ListOfWorkflowRuleSet	The extracted data for all workflow rules for all objects.	Not applicable	Not applicable	Output

Return Value of the Call

The workflow rule sets are returned.

WorkflowRuleSetUpsert

Updates existing workflow rule configuration data or inserts new data. The Manage Workflow Rules privilege is required (to create workflow rules for the User record type, the Manage Workflow Rules for User privilege is also required). Additionally, the Workflow Cancel Save privilege is required if the Cancel save setting is to be updated or inserted.

Note: It is recommended that you use the WorkflowRuleSetInsertOrUpdate method rather than the WorkflowRuleSetUpsert method.

Usage

Use the WorkflowRuleSetUpsert method to update or insert workflow rule configuration data. The Manage Workflow Rules privilege is required.

Caution: New workflow rules are inserted. Existing workflow rules are updated, but existing workflow rules that are not in the request are deleted.

The apData:WorkflowRuleSet argument has the following child elements:

• RecordType. The record type (required).

• TriggerEvent. The event that triggers the workflow rule (required). The possible values and the associated trigger events are as follows:

Trigger Event	TriggerEvent LIC
When New Record Saved	WriteRecordNew
When Modified Record Saved	WriteRecordUpdated
Before Modified Record Saved	PreWriteRecord
Before Record Is Deleted	PreDeleteRecord
After Association With Parent	Associate
After Dissociation From Parent	Dissociate
When Record Is restored	RestoreRecord
When Records are merged	MergeRecords
Scheduled Event	ScheduledEvent

• ParentRecordType. The parent record type. This is specified if the trigger event is After Association With Parent or After Dissociation From Parent. These trigger events are supported only for the Account, Contact, and Opportunity record types.

• ListOfWorkflowRules. The list of workflow rules for the record type and trigger event. Each <WorkflowRule> element has the following child elements:

  • WorkflowName. The name of the workflow rule (required). This name is used to reference an associated workflow action set.

  • Active. Whether the workflow rule is enabled or disabled.

  • Exit. Whether exiting a workflow in a sequence of workflows is enabled. If the condition on the rule is met, the active actions on the workflow rule are performed. However, none of the subsequent workflow rules that are based on the same record type and the same trigger event, and where applicable, the same parent record type, are triggered.

    Note: For workflow rules where <TriggerEvent> has the value ScheduledEvent, the <Exit> element is always set to true and is read-only.

  • Description. A description of the workflow rule.

  • WorkflowRuleCondition. The condition for the workflow rule.

    Note: You cannot specify a condition for a workflow rule that has the Scheduled Event trigger event. If the <WorkflowRuleCondition> element is populated when you insert or update a workflow rule that has the Scheduled Event trigger event, then the element is ignored.

  • CancelSave. Whether Cancel Save processing is performed, if the condition is not met.

  • Order. The order number for the workflow rule. The order number determines the order in which Oracle CRM On Demand invokes a sequence of workflow rules that are based on the same record type and the same trigger event, and if applicable, on the same parent record type.

    Note: The <Order> element is read-only for workflow rules that have the Scheduled Event trigger event because such workflow rules are not performd as part of a sequence.

  • DisplayMessage. The message returned if the condition is met, and if cancel save processing is performed.

• ListOfWorkFlowTranslations. Translations in the languages activated for your company of the display messages that are returned if the condition on a rule is not met and the save operation is canceled. Each <WorkflowTranslation> element has the following child elements:

  • LanguageCode. The three-letter language code for the language.

  • DisplayMessageTranslation. The translation in the language identified by the language code.

Note: The order of invoking of workflow rules is determined by the sequence of <WorkflowRule> elements.

The following child elements of <WokflowRule> are applicable for the Scheduled Event trigger event only:

• StartDateTime. The date and time for the first instance of the scheduled event to be executed.

• EndDateTime. The date and time after which no further instances of the scheduled event are to be executed.You must specify a value for either EndDateTime or NumOccurrence.

• RecurrenceType. The type of recurrence (required). Valid values are: Hourly, Daily, Weekly, Monthly, Yearly.

• RecurrencePeriod. An integer corresponding to the value of the Every field in the UI. For example, if the value is 2 and <RecurrenceType> has the value Monthly, the scheduled event occurs every 2 months.

• LastDayOfMonth. Whether the event occurs on the last day of the month. This value is only applicable if <RecurrenceType> has the value Monthly.

• NumOccurrence. A number of occurrences for the schedule event. This value is only applicable if a value for <EndDateTime> is not specified.

• ListName. The name of the filtered list that returns the records on which you want the workflow actions to act. Corresponds to the UI field: Execute rule for records matching the conditions of the list. If the list has the same name as other lists to which the user has access in a target environment, the scheduled events will run against the most personalized of those lists after migration to the new environment.

• ScheduledInstancesInitiatedByUser. The user ID of the user who initiates the workflow rule. This is the ID of the user who was the last person to modify the scheduled event through the user interface and not necessarily the user who is migrating workflow rules. Corresponds to the UI field: Initiated By. This element is read-only.

• ScheduledEventStatus. The status of the scheduled event. Possible values are: Not Scheduled, Scheduled, Terminated, Completed. This element is read-only.

• EnableNotification. Whether email notifications are sent is sent to the user who last modified the scheduled event before the instance of the event is generated. If the value is true, an email is sent when any of the following happens:

  • An instance of the scheduled event completes successfully.

  • An instance of the scheduled event fails.

  • An instance of the scheduled event is deleted from the Workflow Wait Monitor.

For more information about workflow rules, see Oracle CRM On Demand Online Help.

Arguments

The following table describes the arguments taken by the WorkflowRuleSetUpsert method.

Table Arguments Taken by the WorkflowRuleSetUpsert Method

Name	Description	Required	Default	I/O
apData:WorkflowRuleSet	The workflow rule data to be updated or inserted.	Yes	Not applicable	Input
Status	The status of the call.	Not applicable	Not applicable	Output

Return Value of the Call

The status is returned.

WorkflowRuleSetInsertOrUpdate

Updates existing workflow rule configuration data or inserts new data. The Manage Workflow Rules privilege is required (to create workflow rules for the User record type, the Manage Workflow Rules for User privilege is also required). Additionally, the Workflow Cancel Save privilege is required if the Cancel Save setting is to be updated or inserted.

Note: It is recommended that you use the WorkflowRuleSetInsertOrUpdate method rather than the WorkflowRuleSetUpsert method.

Usage

Use the WorkflowRuleSetInsertOrUpdate method to update or insert workflow rule configuration data.

New workflow rules are inserted and existing workflows rules are updated. Workflow rules that are not identified in the request are not affected. This is in contrast with the WorkflowRuleSetUpsert method, which deletes workflow rules not identified in the request.

Child elements of apData:WorkflowRuleSet provide user keys to identify workflow rule records in a request in the following order:

1. <RecordType> and <TriggerEvent> and <Order>

2. <WorkflowName>

The same order is followed for all the workflow child containers. If no workflow rule is located using these criteria, a new workflow is inserted with the configuration specified in the request.

See WorkflowRuleSetUpsert for information about the workflow rule data specified in apData:WorkflowRuleSet.

For more information about workflow rules, see Oracle CRM On Demand Online Help.

Arguments

The following table describes the arguments taken by the WorkflowRuleSetInsertOrUpdate method.

Table Arguments Taken by the WorkflowRuleSetInsertOrUpdate Method

Name	Description	Required	Default	I/O
apData:WorkflowRuleSet	The workflow rule data to be updated or inserted.	Yes	Not applicable	Input
Status	The status of the call.	Not applicable	Not applicable	Output

Return Value of the Call

The status is returned.

WorkflowUserSetInsertOrUpdate

Inserts workflow user configuration data. The Manage Workflow Rules privilege is required.

Usage

Use the WorkflowUserSetInsertOrUpdate method to insert workflow user configuration data. The method does not update data. The configuration data is for users for whom scheduled events for Analytics are created.

To insert users you specify the workflow name with unique values for the <UserID> or <UserLoginName> child elements of apData:WorkflowUser. If some of the specified user data results in an error, for example, if a value for a user is not unique, the whole request is rolled back.

The apData:WorkflowUserSet argument has the following child elements:

• WorkflowName. The workflow name (required).

• WorkflowUser. The workflow user data, specified in the following child elements:

• UserLastName. The user’s last name.

• UserFirstName. The user’s first name.

• UserFullName. The user’s full name.

• UserEmail. The user’s email address.

• UserAlias. The user alias of the user.

• UserId. The user’s ID.

• UserExternalSystemId. The external system ID of the user.

• UserLoginName. The login name for the user.

For more information about workflow rules, see Oracle CRM On Demand Online Help.

Arguments

The following table describes the arguments taken by the WorkflowUserSetInsertOrUpdate method.

Table Arguments Taken by the WorkflowUserSetInsertOrUpdate Method

Name	Description	Required	Default	I/O
apData:WorkflowUserSet	The workflow user data to be updated or inserted.	Yes	Not applicable	Input
Status	The status of the call.	No applicable	Not applicable	Output

Return Value of the Call

The status is returned.

WorkflowUserSetReadForRuleSet

Extracts workflow user configuration data. The Manage Workflow Rules privilege is required.

Usage

Use the WorkflowUserSetReadForRuleSet method to extract workflow user configuration data. The data is for users for whom scheduled events for Analytics are created.

The <RecordType> and <TriggerEvent> elements of the apQuery:WorkflowUserForRuleSet argument are required and must specify Analytics and ScheduledEvent respectively. The workflow is specified with the <WorkflowName> element of apQuery:WorkflowUserSet.

See WorkflowRuleSetInsertOrUpdate for information about the workflow rule data specified in apData:WorkflowUserSet.

Arguments

The following table describes the arguments taken by the WorkflowUserSetReadForRuleSet method.

Table Arguments Taken by the WorkflowUserSetReadForRuleSet Method

Name	Description	Required	Default	I/O
apQuery:WorkflowUserForRuleSet	The workflow user set query criteria.	Yes	Not applicable	Input
apData:ListOfWorkflowUserSet	The extracted workflow user set data.	Not applicable	Not applicable	Output

Return Value of the Call

The workflow user set data is returned.

WorkflowUserSetDelete

Deletes workflow user configuration data. The Manage Workflow Rules privilege is required.

Usage

Use the WorkflowUserSetDelete method to delete workflow user configuration data.

To identify users for deletion, you can specify values for the <UserID> and <UserLoginName> child elements of apQuery:WorkflowUserSet.

See WorkflowUserSetInsertOrUpdate for information about the workflow user data specified in apQuery:WorkflowUserSet.

Arguments

The following table describes the arguments taken by the WorkflowUserSetDelete method.

Table Arguments Taken by the WorkflowUserSetDelete Method

Name	Description	Required	Default	I/O
apQuery:WorkflowUserSet	The workflow user set.	Yes	Not applicable	Input
Status	The status of the call.	Not applicable	Not applicable	Output

Return Value of the Call

The status is returned.

Data Loader API Calls

In Oracle CRM On Demand you can use the Oracle Data Loader On Demand tool to perform bulk data import operations. Client applications can also take advantage of the API used by the tool to make Web services calls to submit bulk import requests.

Users with the Admin Import privilege can download the Oracle Data Loader On Demand tool from the Oracle CRM On Demand UI. When you download the tool, a WSDL file is provided as part of the.zip file: OracleDataLoaderOnDemandImportServices.wsdl.

The following table lists the calls available with the Data Loader API.

Table Calls Available in the Data Loader API

Name	Description
BulkOpImportCreateRequest	Creates a bulk import request.
BulkOpImportSendData	Imports the data. The BulkOpImportCreateRequest call must be made before BulkOpImportSendData. Subsequently, BulkOpImportSendData calls can be made repeatedly to send data for importing.
BulkOpImportGetRequestDetail	Gets the details of a bulk import request.

BulkOpImportCreateRequest

Creates a bulk import request.

Usage

Use the BulkOpImportCreateRequest method to create a bulk import request.

The arguments taken by the method correspond to elements in the WSDL file, as described in the table in the Arguments section.

The xsdLocal1:ImportOptions argument specifies the import options, which are similar to the options available in the Import Wizard in the Oracle CRM On Demand application:

• CSVDelimiter. The type of CSV delimiter used in the file: comma (,) or semi-colon (;).

• DateTimeFormat. The date and time format used in the CSV file: usa, can, eur, uk, other.

• DuplicateCheckOption. Whether the Row Id (rowid) or external ID (externalid) are used for duplicate checking.

• ErrorLogLevel. The level of error logging:

  • all. All messages

  • errors. Error messages only.

  • errorswarnings. Error messages and warning messages only.

Typical customer import data is contained in a CSV file with the following format:

ColumnName1, ColumnName2, ...
Data1, Data2, ...
Data1, Data2, ...
...

The xsdLocal1:ListOfFieldMappings element specifies the mapping of CSV column names to field names in Oracle CRM On Demand. For example:

<ns1:ListOfFieldMappings>
	<ns1:FieldMapping>
		<ns1:CSVColumnName>
			Web Site
		</ns1:CSVColumnName>
		<ns1:FieldName>
			Home Page
		</ns1:FieldName>
	</ns1:FieldMapping>
</ns1:ListOfFieldMappings>

CSVColumnHeaders specifies the list of CSV column names, for example:

<ns0:CSVColumnHeaders>
"Account Name","External Unique Id","Web Site","Account Location"
</ns0:CSVColumnHeaders>

The mappings are validated and if everything is correct, the import request is created.

Arguments

The following table describes the arguments taken by the BulkOpImportCreateRequest method.

Table Arguments Taken by the BulkOpImportCreateRequest Method

Name	Description	Required	Default	I/O
DataFileName	The name of the data file to be imported, for example, account1.csv	Yes	Not applicable	Input
RecordType	The record type to be imported.	Yes	Not applicable	Input
xsdLocal1:ImportOptions	The list of import options.	No	Not applicable	Input
xsdLocal1:ListOfFieldMappings	The mapping of CSV file column names and their corresponding fields.	Yes	Not applicable	Input
CSVColumnHeaders	The list of column names from the CSV file.	Yes	Not applicable	Input
EnableImportAudit	Enables or disables auditing of record creation/update during import requests. This setting takes effect only if the user has the privilege Manage Record Auditing for Imports, otherwise it is ignored. Accepted values are true or false.	No	true	Input
EnableMailNotification	Enables or disables email notifications for import requests. Accepted values are true or false.	No	true	Input
ImportBlankInMSP	Enables or disables the importing of blank values in multi-select picklist fields. Accepted values are true or false.	No	false	Input
SendUserLogFile	Whether the user log file is attached to the email notification for import requests. If email notification is disabled, SendUserLogFile is ignored. Accepted values are true or false.	No	false	Input
CSVRowCount	The number of data records in the data file to be imported.	Yes	Not applicable	Input
Operation	The operation for the current request, such as insert, update.	Yes	Not applicable	Input
ClientVersion	The current Data Loader client version number.	No	Not applicable	Input
RequestId	The ID of the request created.	Not applicable	Not applicable	Output
Status	The status of this Web service request.	Not applicable	Not applicable	Output
ErrorMessage	Any error message from this Web service request, or a message indicating success.	Not applicable	Not applicable	Output

Return Value of the Call

The request ID, status, and any error message are returned.

BulkOpImportSendData

Imports the data for a bulk import request.

Usage

Use the BulkOpImportSendData method to import the data for a bulk import request.

The BulkOpImportCreateRequest call must be invoked before BulkOpImportSendData by the client.

...

The ListOfCSVData element specifies the row data from the CSV file. For example:

<ns1:ListOfCSVData>
	<ns1:CSVData>
		<ns1:Row>
			"High Quality Moving Company","HQMC","www.highmoving.net","San Jose"
		</ns1:Row>
	</ns1:CSVData>
</ns1:ListOfCSVData>

The CSV data is processed and the actual import performed.

Arguments

The following table describes the arguments taken by the BulkOpImportSendData method.

Table Arguments Taken by the BulkOpImportSendData Method

Name	Description	Required	Default	I/O
RequestId	The request ID that was created.	Yes	Not applicable	Input/Output
TotalNumberOfCSVDataLists	The total number of BulkOpImportSendData calls needed to send all CSV file data.	Yes	Not applicable	Input
xsdLocal1:ListOfCSVData	The actual list of CSV data contained in the CSV file.	Yes	Not applicable	Input
StartRecordNumber	The starting line number of the CSV data.	Yes	Not applicable	Input
ClientVersion	The current data loader client version number.	No	Not applicable	Input
Status	The status of this Web service call.	Not applicable	Not applicable	Output
ErrorMessage	Any error message from this Web service call, or a message indicating success.	Not applicable	Not applicable	Output

Return Value of the Call

The request ID, status, and any error message are returned.

BulkOpImportGetRequestDetail

Gets the details of a bulk import request.

Usage

Use the BulkOpImportGetRequestDetail method to get the details of a bulk import request, which is identified by the RequestId argument.

Arguments

The following table describes the arguments taken by the BulkOpImportGetRequestDetail method.

Table Arguments Taken by the BulkOpImportGetRequestDetail Method

Name	Description	Required	Default	I/O
RequestId	The request ID.	Yes	Not applicable	Input/Output
ClientVersion	The current data loader client version number.	No	Not applicable	Input
RequestStatus	The status of the request.	Not applicable	Not applicable	Output
RecordType	The record type of the request.	Not applicable	Not applicable	Output
RequestedBy	The requestor of the request.	Not applicable	Not applicable	Output
CompletionTime	The time and date the request completed.	Not applicable	Not applicable	Output
RequestTime	The time and date the request was submitted to be processed.	Not applicable	Not applicable	Output
NumberSubmitted	The number of records to be imported by the request.	Not applicable	Not applicable	Output
NumberProcessed	The number of records processed by the request.	Not applicable	Not applicable	Output
NumberPartialImported	The number of records partially imported by the request.	Not applicable	Not applicable	Output
NumberNotImported	The number of records not imported by the request.	Not applicable	Not applicable	Output
NumberSuccessImported	The number of records successfully imported by the request.	Not applicable	Not applicable	Output
Status	The status of this Web service call.	Not applicable	Not applicable	Output
ErrorMessage	Any error message from this Web service call.	Not applicable	Not applicable	Output

Return Value of the Call

The output arguments.