IndicatorType

Contents

• IndicatorType

  • Summary

  • Create

  • Read Single

  • Read Multiple

  • Update

  • Delete

Summary

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

Create

JSON Schema

Required parameters are in bold.

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

POST /api/indicators/type

Creates a new indicator type.

Example request:

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

{
  "value": "Email - Address"
}

Example response:

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

{
  "id": 1,
  "value": "Email - Address"
}

Request Headers

• Authorization – Optional Apikey value

Response Headers

• Content-Type – application/json

Status Codes

• 201 Created – Indicator type created

• 400 Bad Request – JSON does not match the schema

• 401 Unauthorized – Invalid role to perform this action

• 409 Conflict – Indicator type already exists

Read Single

GET /api/indicators/type/(int: indicator_type_id)

Gets a single indicator type given its ID.

Example request:

GET /indicators/type/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": "Email - Address"
}

Request Headers

• Authorization – Optional Apikey value

Response Headers

• Content-Type – application/json

Status Codes

• 200 OK – Indicator type found

• 401 Unauthorized – Invalid role to perform this action

• 404 Not Found – Indicator type ID not found

Read Multiple

GET /api/indicators/type

Gets a list of all the indicator types.

Example request:

GET /indicators/type 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": "Email - Address"
  },
  {
    "id": 2,
    "value": "URI - Domain Name"
  }
]

Request Headers

• Authorization – Optional Apikey value

Response Headers

• Content-Type – application/json

Status Codes

• 200 OK – Indicator types 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/type/(int: indicator_type_id)

Updates an existing indicator type.

Example request:

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

{
  "value": "URI - Domain Name",
}

Example response:

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

{
  "id": 1,
  "value": "URI - Domain Name"
}

Request Headers

• Authorization – Optional Apikey value

Response Headers

• Content-Type – application/json

Status Codes

• 200 OK – Indicator type updated

• 400 Bad Request – JSON does not match the schema

• 401 Unauthorized – Invalid role to perform this action

• 404 Not Found – Indicator type ID not found

• 409 Conflict – Indicator type already exists

Delete

DELETE /api/indicators/type/(int: indicator_type_id)

Deletes an indicator type.

Example request:

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

• 401 Unauthorized – Invalid role to perform this action

• 404 Not Found – Indicator type ID not found

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