You can use public API endpoints to set up integration between BigPicture and external tools. To get responses, you need to have admin permissions.

Synchronize absences of your Resources

Provide API to synchronize the following absences of your Resources with data from other systems used by your organization, e.g., SAP. 

  • Regular work time
  • Holiday
  • Sick leave

Jira and BigPicture admins can perform queries on these endpoints:

OperationRequest type: URLAdditional infoExample of queryExample of response

Get absence for a particular Resource

GET baseUrl/public/ppm/resources/{individualId}/absences

Accept: application/json

Authorization: Bearer jwt

Cookie: JSESSIONID=sessionId

Replace baseUrl with your real URL, for example: https://qa.softwareplant.com/prod/rest/softwareplant-bigpicture/1.0 

For {individualId}, use a pattern: EXT_USER@<extplatform_id>@<user_id_in_extplatform>

Replace <extplatform_id> with an ID for an external platform you use data from. If your default external platform is Jira Server, enter 2. To check <extplatform_id>, go to App Configuration → Integrations →  Connections. Click F12 to see a side window on the right. Go to "Network" → "Fetch/XHR". Refresh the page, click "extplatform" and navigate to the "Preview" section. The <extplatform_id> will be visible there, as presented below. Copy an ID for the platform you want to use. 

Next, replace <user_id_in_extplatform> with a real ID of the user from the external platform you want to use (for Jira Server, enter a user ID in Jira, for another extplatform like Trello, provide a user ID in Trello).
If <user_id_in_extplatform> is an email address, double “@” and use the pattern EXT_USER@@<extplatform id>@@<email@com>, then provide a real email in <email@com>.

You can generate a Bearer jwt token in BigPicture -> My Profile -> API tokens. For more info, click here. The token is valid for 1 year. 

To catch your sessionId, you can:
Open BigPicture and click F12 to see a side window on the right. Go to "Network" -> "Fetch/XHR". Refresh the page and copy your JSESSIONID, as presented below.

Example of API response for Resource absence:

Create absence for a particular Resource

POST baseUrl/public/ppm/resources/{individualId}/absences

Content-Type: application/json

Authorization: Bearer jwt

Cookie: JSESSIONID=sessionId

Request Body:

{ "startDate": "2022-12-02", "endDate": "2022-12-02", "absenceType": "HOLIDAY", "comment": "new comment content", "percentageUnavailability": 100 }

There are 5 different absenceType you can use:

  • HOLIDAY
  • LEAVE AT REQUEST
  • SICK LEAVE
  • MATERNITY LEAVE
  • OTHER REASON

You can set percentageUnavailability to 50 or 100. 
Other values are not supported. 50 means the Resource is absent half a day, while 100 informs that the Resource is absent all day. 

To provide data, use the pattern: YYYY-MM-dd.

Update absence for a particular Resource

PUT baseUrl/public/ppm/resources/{individualId}/absences?startDate={startDate}

Content-Type: application/json

Authorization: Bearer jwt

Cookie: JSESSIONID=sessionId

Request Body:

{ "startDate": "2024-07-21", "endDate": "2024-09-21", "absenceType": "OTHER REASON", "comment": "updated comment content", "percentageUnavailability": 50 }

Delete absence for a particular Resource

DELETE baseUrl/public/ppm/resources/{individualId}/absences?startDate={startDate}

Content-Type: application/json

Authorization: Bearer jwt

Cookie: JSESSIONID=sessionId

Get all Teams in a given Box

Jira and BigPicture admins can use the following endpoint to get all Teams in a given Box.

OperationRequest type: URLAdditional infoExample of queryExample of response

Get all Teams in a given Box

GET baseURL/public/ppm/teams?boxIds={boxId1}&boxIds={boxId2}

Accept: application/json

Authorization: Bearer jwt

Cookie: JSESSIONID=sessionId

Replace baseUrl with your real URL, for example: https://qa.softwareplant.com/prod/rest/softwareplant-bigpicture/1.0 

Replace {boxId1}, {boxId2} with real IDs. You can enter as many boxIds as you want. You can find your boxId in the URL bar or next to the status of the Box, as presented below.

You can generate a Bearer jwt token in BigPicture -> My Profile -> API tokens. For more info, click here. The token is valid for 1 year. 

To catch your sessionId, you can:
Open BigPicture and click F12 to see a side window on the right. Go to "Network" -> "Fetch/XHR". Refresh the page and copy your JSESSIONID, as presented below.

Example of GET Team response:



Get task assignment of your Resources

 Jira and BigPicture admins can use the following endpoint to get assignments of tasks for Resources.

OperationRequest type: URLAdditional infoExample of queryExample of response

Get assignments of tasks for Resources

GET baseURL/public/ppm/boxarea/resourcetaskassignment/{boxId}/
resourcetaskassignment?startDate={startDate}&endDate={endDate}&taskEffortMode={taskEffortMode}

Accept: application/json

Authorization: Bearer jwt

Cookie: JSESSIONID=sessionId

Replace baseUrl with your real URL, for example: https://qa.softwareplant.com/prod/rest/softwareplant-bigpicture/1.0 

Replace {boxId} with real boxId of box you would like to retrieve data from. You can find your boxId in the URL bar or next to the status of the Box, as presented below.

To provide data, use the pattern: YYYY-MM-dd.

The following taskEffortMode can be applied:

  • ORIGINAL_EFFORT_ESTIMATE,
  • REMAINING_EFFORT_ESTIMATE,
  • STORY_POINT_EFFORT_ESTIMATE

By default, ORIGINAL_EFFORT_ESTIMATE will be generated for taskEffortMode even If you do not replace {taskEffortMode} in the endpoint.

You can generate a Bearer jwt token in BigPicture -> My Profile -> API tokens. For more info, click here. The token is valid for 1 year. 

To catch your sessionId, you can:
Open BigPicture and click F12 to see a side window on the right. Go to "Network" -> "Fetch/XHR". Refresh the page and copy your JSESSIONID, as presented below.

Example task assignment response: