Bookshelf Home | Contents | Index | PDF     

Oracle Web Services On Demand Guide > Web Services On Demand API Calls > Service API Calls >

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

Table 65 describes the arguments taken by the UpdateCascadingPicklists method.

Table 65. 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>

    
Oracle Web Services On Demand Guide, Version 25.0 (Oracle CRM On Demand Release 37) Copyright © 2018, Oracle and/or its affiliates. All rights reserved. Legal Notices.