PI37990: WL.JSONSTORE.JSONSTOREINSTANCE.FINDBYID DESCRIPTION IN THE KNOWLEDGE CENTER IS WRONG.

IBM MobileFirst Platform Foundation Interim Fix README for 7.1
IBM MobileFirst Platform Foundation Interim Fix README for 7.0
IBM MobileFirst Platform Foundation Interim Fix README for 6.3
IBM Worklight Interim Fix README for 6.2.0.1

APAR status

• Closed as documentation error.

Error description

• According to the topic IBM MobileFirst Platform Foundation
  6.3.0>API reference>MobileFirst client-side API>JavaScript
  client-side API>Classes>WL.JSONStore.JSONStoreInstance,
  "findById" only has one parameter:
  
  {Promise} findById(options)
  
  The correct syntax with two parameters appears at
  https://www-01.ibm.com/support/knowledgecenter/SSHS8R_6.3.0/com.
  ibm.worklight.dev.doc/devref/r_jsonstore_gs_javascript.html?lang
  =en:
  // Alternatives:
  // - findById(1, options) which locates documents by their _id
  field
  
  
  Additional Keywords:
  
  Worklight Versions Affected: 6.1 and up.
  
  Initial Impact: Medium
  

Local fix

• Use the correct values described above
  

Problem summary

• ****************************************************************
  * USERS AFFECTED:                                              *
  * all                                                          *
  ****************************************************************
  * PROBLEM DESCRIPTION:                                         *
  * The description of "findById" is wrong.                      *
  ****************************************************************
  * RECOMMENDATION:                                              *
  * Use the following description instead:                       *
  *                                                              *
  * {Promise} findById(data, options): Returns one or more       *
  * documents that match the _id that is supplied to the         *
  * function.                                                    *
  *                                                              *
  * Parameters:                                                  *
  *     {array} data - An array of _id                           *
  *     {object} options Optional                                *
  *     {array} options.filter Optional - Return only the        *
  * specified search fields, by default return _id and json.     *
  *     {array} options.sort Optional - Sort documents based on  *
  * their search fields, either ascending or descending.         *
  *     {function} options.onSuccess Optional - Deprecated.      *
  * Success callback.                                            *
  *     {function} options.onFailure Optional - Deprecated.      *
  * Failure callback.                                            *
  *                                                              *
  * Returns:                                                     *
  *     {Promise} Resolved when the operation succeeds, returns  *
  * an array of results. Rejected when there is a failure.       *
  ****************************************************************
  -
  

Problem conclusion

• Updated Knowledge Center topic, for all releases V6.2 to V7.1
  

Temporary fix

Comments

APAR Information

• APAR is sysrouted FROM one or more of the following:

• APAR is sysrouted TO one or more of the following:

Fix information

Applicable component levels