GET /problems/{problemAreaId}

Get a Problem Area

Retrieves a specific Problem Area by its ID. Problem Areas are used to classify related types of issues in a facility, asset, or service environment. They help structure issue categories and are used to organize Problem Types. This endpoint returns the details of the specified Problem Area.

Operation ID: getProblemArea

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 object

Problem Area model structure details

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

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

404

message string

Example: Resource not found

more_info string | null

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

play_circle Try It

Environment

Authorization

Bearer

Path Parameters

problemAreaId

filter_alt Filters

Pagination

GET https://api.sandbox.infraspeak.com/v3/problems/{problemAreaId}

curl -X GET \
  'https://api.sandbox.infraspeak.com/v3/problems/{problemAreaId}' \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer YOUR_API_TOKEN'

const response = await fetch('https://api.sandbox.infraspeak.com/v3/problems/{problemAreaId}', {
  method: 'GET',
  headers: {
    'Accept': 'application/json',
    'Content-Type': 'application/json',
    'Authorization': 'Bearer YOUR_API_TOKEN',
  },
});

const data = await response.json();

$response = Http::withHeaders([
    'Accept' => 'application/json',
    'Content-Type' => 'application/json',
])->withToken('YOUR_API_TOKEN')
  ->get('https://api.sandbox.infraspeak.com/v3/problems/{problemAreaId}');

import requests

response = requests.get(
    'https://api.sandbox.infraspeak.com/v3/problems/{problemAreaId}',
    headers={
        'Accept': 'application/json',
        'Content-Type': 'application/json',
        'Authorization': 'Bearer YOUR_API_TOKEN',
    },
)

data = response.json()

data_object Example Response

200 OK

{
    "data": {
        "id": "888",
        "type": "problem_area",
        "attributes": {
            "problem_id": 888,
            "name": "Electric",
            "full_name": "Electric - Electric",
            "description": "Area of problems related to electricity",
            "entity_id": 1,
            "created_at": "2022-10-06 11:35:28",
            "updated_at": "2022-10-06 11:35:28",
            "has_network_mapping": false,
            "is_from_network": false
        },
        "relationships": {
            "children": {
                "data": {
                    "type": "problem_type",
                    "id": "123"
                }
            }
        }
    }
}

400 Bad Request. Occurs when invalid parameters are provided or on data validation errors. For example, trying to create a resource without providing required fields. In this case, you can check the `properties` attribute on the response for more details.

{
    "status": "error",
    "error": {
        "properties": {},
        "dev_message": "Property validation error. Check the \"properties\" section in the response.",
        "http_code": 400,
        "message": "Property validation error.",
        "more_info": "string"
    }
}

401 Unauthorized. Authentication or permission error. E.g.: missing, incorrect or invalid Access Token.

{
    "status": "error",
    "error": {
        "http_code": 401,
        "message": "Authentication token invalid.",
        "more_info": "string"
    }
}

404 Resource Not Found. Requests to resources that don't exist or are malformed.

{
    "status": "error",
    "error": {
        "http_code": 404,
        "message": "Resource not found",
        "more_info": "string"
    }
}

429 Too Many Requests. The client has sent too many requests in a given amount of time (check Throttling section).

{
    "status": "error",
    "error": {
        "http_code": 429,
        "message": "Too Many Requests.",
        "more_info": "string"
    }
}

500 Internal Server Error. Please, report us and try to provide as much information as possible, such as the endpoint, HTTP request headers and request body if applicable.

{
    "status": "error",
    "error": {
        "http_code": 500,
        "message": "An error has occurred during the request.",
        "more_info": "string"
    }
}