IndicatorStatus

Contents

• IndicatorStatus

  • Summary

  • Create

  • Read Single

  • Read Multiple

  • Update

  • Delete

Summary

Resource	Operation	Description
IndicatorStatus	POST /api/indicators/status	Creates a new indicator status.
	GET /api/indicators/status/(int:indicator_status_id)	Gets a single indicator status given its ID.
	GET /api/indicators/status	Gets a list of all the indicator statuses.
	PUT /api/indicators/status/(int:indicator_status_id)	Updates an existing indicator status.
	DELETE /api/indicators/status/(int:indicator_status_id)	Deletes an indicator status.

Create

JSON Schema

Required parameters are in bold.

type	object
properties
value	type	string
	maxLength	255
	minLength	1
additionalProperties	False

POST /api/indicators/status

Creates a new indicator status.

Example request:

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

{
  "value": "New"
}

Example response:

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

{
  "id": 1,
  "value": "New"
}

Request Headers

• Authorization – Optional Apikey value

Response Headers

• Content-Type – application/json

Status Codes

• 201 Created – Indicator status created

• 400 Bad Request – JSON does not match the schema

• 401 Unauthorized – Invalid role to perform this action

• 409 Conflict – Indicator status already exists

Read Single

GET /api/indicators/status/(int: indicator_status_id)

Gets a single indicator status given its ID.

Example request:

GET /indicators/status/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": "New"
}

Request Headers

• Authorization – Optional Apikey value

Response Headers

• Content-Type – application/json

Status Codes

• 200 OK – Indicator status found

• 401 Unauthorized – Invalid role to perform this action

• 404 Not Found – Indicator status ID not found

Read Multiple

GET /api/indicators/status

Gets a list of all the indicator statuses.

Example request:

GET /indicators/status 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": "New"
  },
  {
    "id": 2,
    "value": "Informational"
  }
]

Request Headers

• Authorization – Optional Apikey value

Response Headers

• Content-Type – application/json

Status Codes

• 200 OK – Indicator statuses found

• 401 Unauthorized – Invalid role to perform this action

Update

JSON Schema

Required parameters are in bold.

type	object
properties
value	type	string
	maxLength	255
	minLength	1
additionalProperties	False

PUT /api/indicators/status/(int: indicator_status_id)

Updates an existing indicator status.

Example request:

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

{
  "value": "Informational",
}

Example response:

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

{
  "id": 1,
  "value": "Informational"
}

Request Headers

• Authorization – Optional Apikey value

Response Headers

• Content-Type – application/json

Status Codes

• 200 OK – Indicator status updated

• 400 Bad Request – JSON does not match the schema

• 401 Unauthorized – Invalid role to perform this action

• 404 Not Found – Indicator status ID not found

• 409 Conflict – Indicator status already exists

Delete

DELETE /api/indicators/status/(int: indicator_status_id)

Deletes an indicator status.

Example request:

DELETE /indicators/status/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 status deleted

• 401 Unauthorized – Invalid role to perform this action

• 404 Not Found – Indicator status ID not found

• 409 Conflict – Unable to delete indicator status due to foreign key constraints