GET /problems/{problemAreaId}/subproblems

List all Problem Types

A Problem Type represents a specific issue that may occur and can be reported. Each Problem Type belongs to a broader Problem Area, which is used to organize and group related issues. Examples:

  • "Power outage" (belongs to the "Electric" problem area)
  • "Water leakage" (belongs to the "Plumbing" problem area)
  • "No heating" (belongs to the "HVAC" problem area)
  • "Unclean room" (belongs to the "Housekeeping" problem area)
Operation ID: getProblemTypes
lock This endpoint requires a Bearer token in the Authorization header.

Path Parameters

Name Type Description
problemAreaId required
path
string

The Problem Area ID

Responses

data array<object>
id string required read-only

ID of the Problem Type

type string required read-only

Model type

problem_type
attributes object required
problem_id integer read-only

Unique identifier of the problem type.

Example: 123

name string read-only

Name of the problem type.

Example: Power outage

full_name string read-only

Name of the problem area concatenated by hyphen with problem name.

Example: Electric - Power outage

description string | null

Additional information

Example: Power outage with no electricity supply

parent_id integer read-only

ID of the problem area.

Example: 1

entity_id integer read-only

The ID of the entity that this problem type belongs to.

Example: 1

created_at string (date-time) read-only

The date and time when the problem area was created

Example: 2022-10-06 11:35:28

updated_at string (date-time) read-only

The date and time when the problem area was last updated

Example: 2022-10-06 11:35:28

has_network_mapping boolean read-only

Specifies if this problem area is shared and has an established mapping to a corresponding entity in an external network

Example:

is_from_network boolean read-only

Specifies if this problem area is shared and has been imported from an external network

Example:

relationships object
parent object
data object
type string read-only
problem_area
id string read-only
included array<object>

List of relationships to be included

id string required read-only

ID of the Problem Area

Example: 888

type string required read-only

Model type

problem_area
attributes object required
problem_id integer required read-only

Unique identifier of the Problem Area

Example: 888

name string required read-only

Name of the Problem Area

Example: Electric

full_name string required read-only

Full name of the Problem Area

Example: Electric - Electric

description string | null required

Additional information

Example: Area of problems related to electricity

entity_id integer required read-only

The ID of the entity that this problem area belongs to

Example: 1

created_at string (date-time) | null required read-only

The date and time when the problem area was created

Example: 2022-10-06 11:35:28

updated_at string (date-time) | null required read-only

The date and time when the problem area was last updated

Example: 2022-10-06 11:35:28

has_network_mapping boolean required read-only

Specifies if this problem area is shared and has an established mapping to a corresponding entity in an external network

Example:

is_from_network boolean required read-only

Specifies if this problem area is shared and has been imported from an external network

Example:

relationships object
children object
data array<object>
type string read-only
problem_type
id string read-only

Example: 123

meta object

Meta model structure details

pagination object
total integer required

Total items.

Example: 1

count integer required

Total items returned for the current page.

Example: 1

per_page integer required

Maximum number of records per page.

Example: 1

current_page integer required

Number of the current page.

total_pages integer required

Number of the total pages.

links object

Requests that return multiple items include a `links` attribute, with links related to request's context.

self string required read-only

Current response link.

Example: /path?page=1

first string required read-only

Link to the first page result.

Example: /path?page=1

last string required read-only

Link to the previous page result.

Example: /path?page=1

next string read-only

Link to the next page result.

Example: /path?page=1

status string
error
error object
properties object

Only present when related to property validation error

dev_message string

Example: Property validation error. Check the "properties" section in the response.

http_code integer
400
message string

Example: Property validation error.

more_info string
status string
error
error object
http_code integer
401
message string

Example: Authentication token invalid.

more_info string
status string
error
error object
http_code integer
429
message string

Example: Too Many Requests.

more_info string
status string
error
error object
http_code integer
500
message string

Example: An error has occurred during the request.

more_info string