GET on a generic dataset

GET

/gateway/{alias}/{path}

const url = 'https://example.com/gateway/example/example';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://example.com/gateway/example/example \
  --header 'Authorization: Bearer <token>'

For a dataset that does not follow the Buildinglinks protocol: the request is passed on to path (which may contain /) at the provider, with its query and body, and the provider’s status, body and Content-Type come back. What the dataset offers is in its catalog entry.

Authorizations

Parameters

Path Parameters

alias

required

string

The connection (abonnement) to call through, as Verbindingen in the connector names it.

path

required

string

The path at the provider; may contain /.

Responses

200

The provider’s answer, passed on.

401

unauthenticated: no key, an unknown key, or an invalid token of the control plane.

application/json

An answer of the gateway itself, not one it passes on.

object

error

required

object

code

required

string

message

required

string

retryable

required

Whether the same request may succeed later.

boolean

Example

{
  "error": {
    "code": "forbidden"
  }
}

403

forbidden: the key lacks the gateway scope, its app may not use this connection, or the app may only read. The provider’s data plane refuses with 403 what the agreement does not cover.

application/json

An answer of the gateway itself, not one it passes on.

object

error

required

object

code

required

string

message

required

string

retryable

required

Whether the same request may succeed later.

boolean

Example

{
  "error": {
    "code": "forbidden"
  }
}

502

upstream_unavailable: the provider’s data plane could not be reached, its answer was larger than 16 MiB, or, when the agreement requires signed requests, its answer had no valid signature.

application/json

An answer of the gateway itself, not one it passes on.

object

error

required

object

code

required

string

message

required

string

retryable

required

Whether the same request may succeed later.

boolean

Example

{
  "error": {
    "code": "forbidden"
  }
}

503

upstream_unavailable: the connection is not active (yet), or renewing the access token failed; evidence_unavailable: the agreement requires signed requests and the request or answer could not be recorded; standby: another instance of this data plane is active. Retryable.

application/json

An answer of the gateway itself, not one it passes on.

object

error

required

object

code

required

string

message

required

string

retryable

required

Whether the same request may succeed later.

boolean

Example

{
  "error": {
    "code": "forbidden"
  }
}