Skip to content
English
  • There are no suggestions because the search field is empty.

Prediction App 2024.7 - API updates

API changes (v1-v2)

There is exceptionally a regression on v1 and v2:

/projectScenarios/{scenarioId}/results

GET

Change in the response body

Property

 

demands.demand.sizeAvailable

UPDATED VALUE

The value will now be equal to sizeNet. This field is kept in v1/v2 for retro-compatibility but should not be used.

6. API changes (v5)

This describes the changes in API, in which a v5 was introduced. All previous API versions (v1 → v4) should still work as expected.

projects/{projectId}/scenarios

POST

Change in the request body

Property

 

groups.isLinked

NEW MANDATORY

A boolean value that indicates wether studies belonging to that group will import demand from trial scenarios in the application (isLinked = true), or if the demands will be expressed in product needs directly (isLinked = false).

demands.code

NEW MANDATORY

Code identifying uniquely a demand inside a project scenario. The demands entered through this interface must only be for studies inside non linked groups.

trials/{trialId}/scenarios

POST

Change in the request body

Property

 

dispensings.kitsPerUnit

 TYPE UPDATED - from integer to positive number

This change is also applied to v4