Querying for a Control's User Properties in an Applet Using the recordcountneeded Parameter

There are times when you need to know the total number of records a query has retrieved, and not just a subset of the total records. You can query for the total record count by using the recordcountneeded parameter, and setting it to true. If you set this parameter to false, then no record count is returned. If neither true nor false is specified, then the default value for recordcountneeded is false.

When using recordcountneeded, the following considerations apply:

• This parameter applies only to GET URLs of /data and /workspace APIs.
• The total record count returns as a response header named: Total-Record-Count
• Total record count gives count records to which you have access.
• It gives a record count of the last business component specified in the request URL.
• The best practice, to optimize performance, is to only use this parameter when a record count is required.

In the following request, the recordcountneeded parameter is set to true, and the response has a header named Total-Record-Count which indicates that there are 2 user properties associated with a control named QueryAssistant in the SIS Account List applet.

• URI: http://ServerName:port/siebel/v1.0/workspace/dev_sadmin_test/Applet/SIS Account List Applet/Control/QueryAssistant/Control User Prop?recordcountneeded=true

• HTTP Method: GET

• Content-Type: application/json

• Authorization: Basic

• Total-Record-Count: 2 (Response Header)