function readOnly(count){ }
Sign Up ›
Starting November 20, the site will be set to read-only. On December 4, 2023,
forum discussions will move to the Trailblazer Community.
Learn More

Browse by Topic
ShowAll Questionssorted byDate Posted
+ Start a Discussion
SteveBowerSteveBower 

API Documentation Bug


Summary: API Documentation uses the *labels* for various AccessLevel fields as opposed to the *values* of those fields.  Ex. Says "Read/Write", should say "Edit".


Detail:

In many places in the API documentation there are descriptions of the various "xxxShare" objects.  Account Share, AccountTerritoryShare, LeadShare, etc.  Each of these objects has one or more "AccessLevel" fields.  For example, AccountShare has AccountAccessLevel, CaseAccessLevel, etc.

The documentation says that these access level should be set to some value and in the description has:
Level of access that the User or Group has to the Account. One of the following values:

    * Owner - User or Group cannot access the Account.
    * Read Only - User or Group can only view the Account.
    * Read/Write - User or Group can view or edit the Account.A value (Private, Read Only or Read/Write) that represents
the type of access granted to the target group for all child cases
of the account.
    * All - User or Group can view, edit, delete, and share the Account with other User. This value is not valid for create or update calls.

AccountTerritoryShare has CaseAccessLevel documented as:

A value (Private, Read Only or Read/Write) that represents the type of access granted to the target group for all child cases of the account.



The bug, I believe, is that these aren't the correct values for these fields.  These are the *Labels*, the values that you need to put into the fields in the objects are actually "All", "Edit", "Read", etc.

I filed a documentation bug, case # 01354639

Thanks, Steve.





 


benjasikbenjasik
we'll look into it, thanks for reporting!