API Reference

All files related to frontend API are in frontend/src/api.

advancedSearchAPI

fetchForAdvancedSearch(genericType, genericItemType)

• Fetch the genericItemType in category genericType in JSON format.

advancedSearchGeneric(genericType, genericItemType, body)

• Update (PUT) the advanced search result specified by genericType and genericItemType with body.

characteristicsAPI

createCharacteristic(params)

updateCharacteristic(uri, params)

fetchCharacteristic(id)

fetchCharacteristics()

deleteCharacteristic(id)

fetchCharacteristicFieldTypes()

fetchCharacteristicsDataTypes()

fetchCharacteristicsOptionsFromClass()

clientAPI

codeAPI

dynamicFormAPI

errorReportAPI

fileUploadingAPI

formulaAPI

genericDataAPI

groupAPI

impactReportAPI

indicatorAPI

fetchIndicators(organizationUri)

• Fetch all indicators linked to organization given by organizationUri in JSON format.

fetchIndicator(uri)

• Fetch an indicator specified by uri in JSON format.

fetchIndicatorInterfaces(organizationUri)

• Fetch all indicator interfaces linked to organization given by organizationUri in JSON format.

createIndicator(params)

• Create (POST) an indicator populated with params.

updateIndicator(params, uri)

• Update (PUT) an indicator given by uri with params.

indicatorReportAPI

internalTypeAPI

needAPI

needSatisfierAPI

organizationAPI

outcomeAPI

fetchOutcomes(organizationUri)

• Fetch all outcomes linked to the organization given by organizationUri in JSON format.

fetchOutcomesThroughTheme(themeUri)

• Fetch all outcomes linked to the theme given by themeUri in JSON format.

fetchOutcomeInterfaces(organizationUri)

• Fetch the interface of the outcome of given organization in JSON format.

createOutcome(params)

• Create (POST) an outcome populated with params.

updateOutcome(params, uri)

• Update (PUT) an outcome given by uri with params.

providersAPI

questionAPI

stakeholderAPI

stakeholderOutcomeAPI

themeAPI

userAPI

userTypesAPI