Sign in to Community
Sign in to view all badges
Expand my Community achievements bar.
The API documentation needs to be improved overall. There are things missing from it, and there are references to v4 and v5, without notes about whether or not they're still relevant. It's hampering our integration efforts.
And offering Jira integration - even if just basic functionality. Or a good whitepaper wireframe for our developers to create the connections.
The documentation took a downturn recently when they moved it to be inside the support articles.
Links I've had to accumulate to get all the information needed for API use:
API-Basics - Most stuff: authentication, gets, posts, deletes, search, fields, custom data, reports, pagination, bulk actions, etc.
Understanding Text Mode - provided insight on how to do distinct lists of conditions
Agreed! WF API doc needs a new look and functionality, my particular complaint is when an object exists independently of a parent record yet there's no way to fetch it with an API call... madness 😄 It should be crystal-clear to any semi-technical admin working with exporting or importing data via REST or automating with an external tool what is possible and what is not.
We are actively working on a complete re-write of our API documentation.
I'd love to see a description column in the API Explorer to indicate what each item is in plain English. Most of the items are fairly straight forward, but some are not clear.
For example, I've recently learned while trying to do a User Kick-Start:
and you need to use the appropriate one depending on which you are working in.
You must be a registered user to add a comment. If you've already registered, sign in. Otherwise, register and sign in.