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

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. Table 68 shows the system names for the Owner and Book fields for some record types.

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

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.