The points of a delivery

GET

/api/v1/delegations/{id}/points

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

The points the delivery covers: as supplier from our own system, as rights holder through the supplier’s data plane.

Authorizations

• session
  viewer
• dpop
  viewer
• bearer
  viewer

Parameters

Path Parameters

id

required

string

The id of the delegation (urn:uuid:…).

Responses

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

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

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

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"
  }
}