Get feature definitions

GET

/v2/clients/{client_id}/domains/{domain_id}/features

const url = 'https://test-pie.streamline.enterprises/v2/clients/client-1/domains/south_australia/features';
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://test-pie.streamline.enterprises/v2/clients/client-1/domains/south_australia/features \
  --header 'Authorization: Bearer <token>'

Authorizations

BearerAuth

Parameters

Path Parameters

client_id

required

string

Example

client-1

domain_id

required

string

Example

south_australia

Responses

200

Feature definitions

application/json

Array<object>

object

name

required

string

json_schema

required

JSON Schema Draft 2020-12 for the feature value; optional default applies when omitted at service init/update.

object

mandatory

required

boolean

Example

[
  {
    "name": "route",
    "json_schema": {
      "type": "string",
      "enum": [
        "Adelaide to Sydney",
        "Sydney to Adelaide"
      ]
    },
    "mandatory": true
  }
]

400

Validation error — malformed input, invalid path parameters, or request that fails syntactic validation.

application/json

object

success

required

boolean

message

required

Human-readable error message

string

Example

{
  "success": false
}

401

Missing or invalid Authorization bearer token, expired token, or token rejected by the authorization layer (e.g. API Gateway JWT authorizer or application validation).

application/json

object

success

required

boolean

message

required

Human-readable error message

string

Example

{
  "success": false
}

403

Authenticated caller lacks the permission required for this operation.

application/json

object

success

required

boolean

message

required

Human-readable error message

string

Example

{
  "success": false
}

404

Requested resource was not found.

application/json

object

success

required

boolean

message

required

Human-readable error message

string

Example

{
  "success": false
}