IndicatorImpact

Summary

Resource

Operation

Description

IndicatorImpact

POST /api/indicators/impact

Creates a new indicator impact.

GET /api/indicators/impact/(int:indicator_impact_id)

Gets a single indicator impact given its ID.

GET /api/indicators/impact

Gets a list of all the indicator impacts.

PUT /api/indicators/impact/(int:indicator_impact_id)

Updates an existing indicator impact.

DELETE /api/indicators/impact/(int:indicator_impact_id)

Deletes an indicator impact.

Create

JSON Schema

Required parameters are in bold.

type

object

properties

  • value

type

string

maxLength

255

minLength

1

additionalProperties

False


POST /api/indicators/impact

Creates a new indicator impact.

Example request:

POST /indicators/impact HTTP/1.1
Host: 127.0.0.1
Content-Type: application/json

{
  "value": "LOW"
}

Example response:

HTTP/1.1 201 Created
Content-Type: application/json

{
  "id": 1,
  "value": "LOW"
}
Request Headers
Response Headers
Status Codes

Read Single

GET /api/indicators/impact/(int: indicator_impact_id)

Gets a single indicator impact given its ID.

Example request:

GET /indicators/impact/1 HTTP/1.1
Host: 127.0.0.1
Accept: application/json

Example response:

HTTP/1.1 200 OK
Content-Type: application/json

{
  "id": 1,
  "value": "LOW"
}
Request Headers
Response Headers
Status Codes

Read Multiple

GET /api/indicators/impact

Gets a list of all the indicator impacts.

Example request:

GET /indicators/impact HTTP/1.1
Host: 127.0.0.1
Accept: application/json

Example response:

HTTP/1.1 200 OK
Content-Type: application/json

[
  {
    "id": 1,
    "value": "LOW"
  },
  {
    "id": 2,
    "value": "HIGH"
  }
]
Request Headers
Response Headers
Status Codes

Update

JSON Schema

Required parameters are in bold.

type

object

properties

  • value

type

string

maxLength

255

minLength

1

additionalProperties

False


PUT /api/indicators/impact/(int: indicator_impact_id)

Updates an existing indicator impact.

Example request:

PUT /indicators/impact/1 HTTP/1.1
Host: 127.0.0.1
Content-Type: application/json

{
  "value": "HIGH",
}

Example response:

HTTP/1.1 200 OK
Content-Type: application/json

{
  "id": 1,
  "value": "HIGH"
}
Request Headers
Response Headers
Status Codes

Delete

DELETE /api/indicators/impact/(int: indicator_impact_id)

Deletes an indicator impact.

Example request:

DELETE /indicators/impact/1 HTTP/1.1
Host: 127.0.0.1

Example response:

HTTP/1.1 204 No Content
Request Headers
Status Codes