Is it possible to get data from BigPicture via Rest-API?

Edlaos
I'm New Here
I'm New Here
Those new to the Atlassian Community have posted less than three times. Give them a warm welcome!
February 6, 2025

Is it possible to get data from BigPicture via Rest-API? If so, I would like to read the year and quarter from all program increments (PI) (as shown in the picture).

BigPicture_01.JPG

Jira URL example: “https://company.atlassian.net/rest/api/3/search?jql= type = Epic AND status = New”

 

BigPicture URL example: here please an example, if it is really possible

 

thx Edi

1 answer

0 votes
Artsiom R February 6, 2025

Hey @Edlaos 

Yes, you can retrieve data from BigPicture via its REST API. You can refer to the official API documentation here.

For your specific case, the endpoint should look something like this:

{baseUrl}/public/ppm/box/{boxId}

Make sure to replace {baseUrl} and {boxId} with the correct URLs for your instance: https://developer.bigpicture.one/reference/baseurl

In response you should get all the details of Art-5 Box from your screenshot, including its hierarchy and names of its children.

Hope this helps.

Artsiom

Edlaos
I'm New Here
I'm New Here
Those new to the Atlassian Community have posted less than three times. Give them a warm welcome!
February 6, 2025

so my BaseUrl is the “https://company.atlassian.net/rest/bigpicture/1.0/public/ppm/box/”

and what do you mean by {boxId}? what should it look like?

Artsiom R February 6, 2025

Each element or container is represented as a Box in BigPicture. It can be PI, task, project, etc. For example, boxIds on your screenshot are: ART-1, ART-5, PROG-36 ...

You need to determine the boxId of the PI you're interested in.

Edoardo Belfiglio February 13, 2025

it doesn't work like that, that's why i'm asking. i tried it earlier too...

 https://company.atlassian.net/rest/bigpicture/1.0/public/ppm/box/ART-1

Edoardo Belfiglio March 6, 2025

hello, I really need help with this problem....

iwebfunctional_2
I'm New Here
I'm New Here
Those new to the Atlassian Community have posted less than three times. Give them a warm welcome!
March 12, 2025

Hello @Edoardo Belfiglio , please read carefully the basicUrl dacumentation https://developer.bigpicture.one/reference/baseurl
based on your BP version it either has {Jira base URL}/rest/softwareplant-bigpicture/1.0 for ver < 8.32 or {Jira base URL}/rest/bigpicture/1.0 for ver >= 8.32

Edoardo Belfiglio March 12, 2025

Hello iwebfunctional_2, thanks for your answer. Yes, I read the documentation. But if you test both URLs, you've easily tested whether it works or not, regardless of the version. But it doesn't work for either, so I need help...

 

URL < 8.32 https://company.atlassian.net/rest/softwareplant-bigpicture/1.0/public/ppm/box/ART-1

 

URL >= 8.32 https://company.atlassian.net/rest/bigpicture/1.0/public/ppm/box/ART-1

iwebfunctional_2
I'm New Here
I'm New Here
Those new to the Atlassian Community have posted less than three times. Give them a warm welcome!
March 12, 2025
You're trying to reach endpoint that doesn't exist @Edoardo Belfiglio 

try the one below:

/rest/softwareplant-bigpicture/1.0/public/ppm/box/box-hierarchy (works for me with 8.21 ver)

This endpoint, it works for 8.21 and above
Please note that not all endpoints work on 8.2x, some requires higher

Note that at the moment, there are few endpoints, you can send feedback to devs and request new endpoints. 

Suggest an answer

Log in or Sign up to answer
TAGS
AUG Leaders

Atlassian Community Events