/
[DRAFT] BigPicture – Frequently Asked Questions: API Access and Documentation

[DRAFT] BigPicture – Frequently Asked Questions: API Access and Documentation

Summary

This article addresses common issues when connecting to the BigPicture Public API, including resolving 404 Not Found errors caused by incorrect endpoint structures.

Questions & Answers

Q: Why am I receiving a "404 Not Found" error when trying to access the BigPicture API at https://[instance].atlassian.net/public/ppm/box?

A: This error typically occurs when the API endpoint URL is incorrectly formatted or incomplete. For BigPicture Cloud, the Public API must follow the specific structures defined in the developer portal. Using a generic or guessed URL path often results in a 404 error because the resource does not exist at that specific location.

To resolve this, ensure you are using the correct base URL and resource path as specified in the BigPicture Developer Portal.

Solution/Workaround

If you are experiencing authentication or "Not Found" errors while using the API, follow these steps:

  1. Consult the Official Reference: Navigate to the BigPicture API Reference to find the exact endpoint for the action you are trying to perform (e.g., GET, POST, or PUT for Boxes).

  2. Verify Authentication: Ensure your Authorization: Bearer <Token> header contains a valid technical user token generated within the BigPicture App settings.

  3. Check Header Requirements: Most endpoints require the following headers:

    • Authorization: Bearer <Your_Token>

    • Accept: application/json

  4. Validate the URL Structure: Ensure there are no typos in the instance name or the resource path (e.g., ensuring /public/ and versioning like /v1/ are correctly placed if required by the specific documentation).

Additional Resources