API Documentation
Is this a new doc? Don't forget to add it to the JSON so it shows up in the navigation!
See the link on the right under "API Reference".

Use Ctrl+click to select multiple products; select at least one product.
 

"API Reference" is typical; select exactly one category.
 

Briefly state the purpose of this API.
 

On-Prem: Product version when API was introduced.
Cloud: "Since <mm/yyyy>" (when API became available).
 

On-Prem: Product version in which this API was deprecated.
Cloud: "Deprecated <mm/yyyy>" -or- leave blank.

 
Use 1-2 sentences to describe the API behavior.
 
Do not repeat the Abstract. Describe how the API works, providing lots of detail about requirements, restrictions, possible unexpected behaviors, etc.
If you reference another API, link to its help topic (use the URL Link icon link icon).
 

API Details

Add  Edit JSON
Click Add to insert the request method that this help topic describes (one per topic).
Click Edit JSON only if you need to modify the generated JSON content, which is used by API Explorer.

Content Type:
If there is only one content type, select it here. If there are multiple content types, select the preferred type here, and then iterate over the list in the Request Headers field.
Request Fields:   
Click Add > Field to insert a table row for each request parameter.
Click Add > Reference to link to a doc that describes the JSON format.
Click Edit JSON only if you need to modify the generated JSON content, which is used by API Explorer.
Optional. Displays only when a Content Type is selected for the Request. This sample is the JSON or XML template of what the client will send to the server.
Add  Edit JSON
On-Prem: Required only for APIs that require authentication.
Cloud: Always required.
Click Add to insert an HTTP header for the request; include the auth authentication parameter that is used in the URI.
Click Edit JSON only if you need to modify the generated JSON content, which is used by API Explorer.
Add  Edit JSON
Click Add to insert a table row for each URL parameter used by this request.
Click Edit JSON only if you need to modify the generated JSON content, which is used by API Explorer.
Add  Edit JSON
Click Add to insert a table row for each query parameter used by this request.
Click Edit JSON only if you need to modify the generated JSON content, which is used by API Explorer.

If there is only one content type, select it here. If there are multiple content types, select the preferred type here, and then iterate over the list in the Response Headers field.
Response Fields:   
Click Add > Field to insert a table row for each response parameter.
Click Add > Reference to link to a doc that describes the JSON format.
Click Edit JSON only if you need to modify the generated JSON content, which is used by API Explorer.
Add  Edit JSON
Click Add to insert an HTTP header for the response.
Click Edit JSON only if you need to modify the generated JSON content, which is used by API Explorer.
Add  Edit JSON
Click Add to insert a table row for each response code.
Click Edit JSON only if you need to modify the generated JSON content, which is used by API Explorer.

Leave blank (not used).
Add  Edit JSON
Leave blank (not used).
Add  Edit JSON
Leave blank (not used).
Add  Edit JSON
Click Add to insert a code example showing how to call this API.
Click Edit JSON only if you need to modify the generated JSON content, which is used by API Explorer.