API Reference
Share SuggestionsContact Support

API response structure

Overview

BigPicture's public API always returns a response in a specific format. There are three main attributes: currentVersion,latestVersion, andcargo.

Response Attributes

1. currentVersion

  • Indicates the current version of the API.
  • Example: "currentVersion": 1

2. latestVersion

  • Specifies the latest version available for the API.
  • Example: "latestVersion": 1

3. cargo

  • Contains the payload of the response. The API Responses described in the Big Picture API Definition section are returned as cargo.
  • Example:
"cargo": {
      // Response content
}

Examples of responses

1. Response from POST public/ppm/box/box endpoint

{
    "currentVersion": 1,
    "latestVersion": 1,
    "cargo": {
        "createdBoxId": "PROG-3045"
    }
}

2. Response from GET public/ppm/box/box-hierarchy endpoint

{
   "currentVersion":1,
   "latestVersion":1,
   "cargo":{
      "boxId":"ROOT",
      "boxStatus":"IN_PROGRESS",
      "boxTypeId":"1",
      "boxName":"Home",
      "boxStartDate":"2010-01-01",
      "boxEndDate":"2069-12-31",
      "boxArchived":false,
      "boxDescription":"",
      "boxIcon":"font-awesome-home@MEDIUM_GRAY",
      "boxChildren":[
         {
            "boxId":"PROG-651",
            "boxStatus":"NOT_STARTED",
            "boxTypeId":"2",
            "boxName":"TC-1407 Right-click menu options on Gantt",
            "boxStartDate":"2021-02-12",
            "boxEndDate":"2021-02-20",
            "boxArchived":false,
            "boxDescription":"",
            "boxIcon":"font-awesome-box-open@VIOLET",
            "boxChildren":[
               
            ]
         }
      ]
   }
}