Ga naar inhoud
buildinglinksbuildinglinks

The points of a source

GET
/api/v1/sources/{id}/points
curl --request GET \
  --url https://example.com/api/v1/sources/example/points \
  --cookie bl_%3Cslug%3E_session=%3Cbl_%3Cslug%3E_session%3E

Asks the system (Buildinglinks protocol) for the points of its koppelingen, with the chosen indeling over them; with provides=topology the indeling itself. Objects the system did not describe this time are listed under unavailable.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
id
required
string

The id of the source.

Query Parameters

Section titled “Query Parameters”
provides
string

topology for the indeling; otherwise the data.

Responses

Section titled “Responses”

200

Section titled “200”

OK.

Media typeapplication/json
object
objects
required
Array<object>

The points of one object.

object
object
required
string
points
Array<object>
object
point_id
required
string
name
string
class
string
access
string
unit
string | null
equipment_id
string | null
location_id
string | null
locations
Array<object>
object
location_id
required
string
name
string
class
string
part_of
string | null
groups
Array<object>
object
group_id
required
string
name
string | null
equipment_ids
Array<string>
equipment
Array<object>
object
equipment_id
required
string
class
string
name
string | null
location_id
string | null
unavailable

Objects the backend did not describe this time (unreachable, error).

Array<object>
object
object
required
string
error
required
string

Example generated

{
  "objects": [
    {
      "object": "example",
      "points": [
        {
          "point_id": "example",
          "name": "example",
          "class": "example",
          "access": "example",
          "unit": "example",
          "equipment_id": "example",
          "location_id": "example"
        }
      ],
      "locations": [
        {
          "location_id": "example",
          "name": "example",
          "class": "example",
          "part_of": "example"
        }
      ],
      "groups": [
        {
          "group_id": "example",
          "name": "example",
          "equipment_ids": [
            "example"
          ]
        }
      ],
      "equipment": [
        {
          "equipment_id": "example",
          "class": "example",
          "name": "example",
          "location_id": "example"
        }
      ]
    }
  ],
  "unavailable": [
    {
      "object": "example",
      "error": "example"
    }
  ]
}

401

Section titled “401”

No valid session, DPoP-bound token or API key.

Media typeapplication/json

The body of every failed call to a management API.

object
error
required
object
code
required

Stable, machine-readable: invalid_request, unauthenticated, forbidden, not_found, conflict, upstream_unavailable, unavailable, internal, or a more specific code of the operation.

string
message
required

For people; may change between versions.

string

Example 

{
  "error": {
    "code": "not_found",
    "message": "unknown negotiation"
  }
}

403

Section titled “403”

The caller lacks the role this operation needs; or a change with the session cookie came from a page of another site (cross_site_request, decisions #83).

Media typeapplication/json

The body of every failed call to a management API.

object
error
required
object
code
required

Stable, machine-readable: invalid_request, unauthenticated, forbidden, not_found, conflict, upstream_unavailable, unavailable, internal, or a more specific code of the operation.

string
message
required

For people; may change between versions.

string

Example 

{
  "error": {
    "code": "not_found",
    "message": "unknown negotiation"
  }
}

404

Section titled “404”

Not found.

Media typeapplication/json

The body of every failed call to a management API.

object
error
required
object
code
required

Stable, machine-readable: invalid_request, unauthenticated, forbidden, not_found, conflict, upstream_unavailable, unavailable, internal, or a more specific code of the operation.

string
message
required

For people; may change between versions.

string

Example 

{
  "error": {
    "code": "not_found",
    "message": "unknown negotiation"
  }
}

409

Section titled “409”

Only a Buildinglinks system lists its points.

Media typeapplication/json

The body of every failed call to a management API.

object
error
required
object
code
required

Stable, machine-readable: invalid_request, unauthenticated, forbidden, not_found, conflict, upstream_unavailable, unavailable, internal, or a more specific code of the operation.

string
message
required

For people; may change between versions.

string

Example 

{
  "error": {
    "code": "not_found",
    "message": "unknown negotiation"
  }
}