IndicatorImpact¶
Summary¶
Resource |
Operation |
Description |
---|---|---|
IndicatorImpact |
Creates a new indicator impact. |
|
Gets a single indicator impact given its ID. |
||
Gets a list of all the indicator impacts. |
||
Updates an existing indicator impact. |
||
Deletes an indicator impact. |
Create¶
JSON Schema
Required parameters are in bold.
type |
object |
|
properties |
||
|
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
Authorization – Optional Apikey value
- Response Headers
Content-Type – application/json
- Status Codes
201 Created – Indicator impact created
400 Bad Request – JSON does not match the schema
401 Unauthorized – Invalid role to perform this action
409 Conflict – Indicator impact already exists
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
Authorization – Optional Apikey value
- Response Headers
Content-Type – application/json
- Status Codes
200 OK – Indicator impact found
401 Unauthorized – Invalid role to perform this action
404 Not Found – Indicator impact ID not found
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
Authorization – Optional Apikey value
- Response Headers
Content-Type – application/json
- Status Codes
200 OK – Indicator impacts found
401 Unauthorized – Invalid role to perform this action
Update¶
JSON Schema
Required parameters are in bold.
type |
object |
|
properties |
||
|
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
Authorization – Optional Apikey value
- Response Headers
Content-Type – application/json
- Status Codes
200 OK – Indicator impact updated
400 Bad Request – JSON does not match the schema
401 Unauthorized – Invalid role to perform this action
404 Not Found – Indicator impact ID not found
409 Conflict – Indicator impact already exists
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
Authorization – Optional Apikey value
- Status Codes
204 No Content – Indicator impact deleted
401 Unauthorized – Invalid role to perform this action
404 Not Found – Indicator impact ID not found
409 Conflict – Unable to delete indicator impact due to foreign key constraints