Instance Properties

The /instance_properties endpoint provides read-only access to instance property definitions. Instance properties define the metadata schema columns for a pattern — the fields that each instance row must or can contain (e.g. NAME, DATA_TYPE, PRECISION).

See Also

• Authentication — Required for all API requests
• Definition of Instance Properties — Configuring instance properties in patterns
• Instance Metadata — Guide to instance metadata concepts
• Patterns API — Pattern definitions
• Functional Roles API — Functional role definitions

GET /api/v1/instance_properties — Find Instance Properties

Retrieve a list of instance property definitions, optionally filtered by pattern.

Endpoint

GET https://app.metakraftwerk.com/api/v1/instance_properties

Query Parameters

Parameter	Type	Required	Description
pattern	string	No	Filter by pattern name.
pattern_id	integer	No	Filter by pattern ID.

INFO

Only non-deleted instance properties are returned.

Response Schema

Returns an array of instance property objects:

Field	Type	Description
id	integer	Unique instance property ID.
pattern_id	integer	Associated pattern ID.
name	string	Property name (e.g. NAME, DATA_TYPE, PRECISION).
datatype	string	Data type of the property (string, integer, etc.).
format	string	Format specification (if applicable).
description	string	Property description.
deleted	boolean	Whether the property is marked as deleted.
required	boolean	Whether the property is required for each instance row.
pos_no	integer	Display position number.

Examples

cURL

# Find by pattern name
curl -X GET "https://app.metakraftwerk.com/api/v1/instance_properties?pattern=CORE_DV_HLS" \
  -H "Authorization: Bearer $ACCESS_TOKEN"

# Find by pattern ID
curl -X GET "https://app.metakraftwerk.com/api/v1/instance_properties?pattern_id=808" \
  -H "Authorization: Bearer $ACCESS_TOKEN"

JavaScript (Fetch)

const response = await fetch(
  'https://app.metakraftwerk.com/api/v1/instance_properties?pattern=CORE_DV_HLS',
  { headers: { 'Authorization': `Bearer ${accessToken}` } }
);

const properties = await response.json();

Response Example

[
  {
    "id": 1860,
    "pattern_id": 808,
    "name": "NAME",
    "datatype": "string",
    "format": null,
    "description": null,
    "deleted": false,
    "required": true,
    "pos_no": 1
  }
]

Error Responses

Status	Condition	Example Message
401	Missing or invalid token	Not authenticated
404	Pattern not found	A pattern with the name 'X' does not exist!

---

GET /api/v1/instance_properties/:id — Get Instance Property

Retrieve a single instance property by its ID.

Endpoint

GET https://app.metakraftwerk.com/api/v1/instance_properties/:id

Path Parameters

Parameter	Type	Required	Description
id	integer	Yes	The instance property ID.

Examples

cURL

curl -X GET "https://app.metakraftwerk.com/api/v1/instance_properties/1860" \
  -H "Authorization: Bearer $ACCESS_TOKEN"

JavaScript (Fetch)

const response = await fetch(
  'https://app.metakraftwerk.com/api/v1/instance_properties/1860',
  { headers: { 'Authorization': `Bearer ${accessToken}` } }
);

const property = await response.json();

Error Responses

Status	Condition	Example Message
401	Missing or invalid token	Not authenticated
404	Instance property not found	No record found for id 'X'

---

POST /api/v1/instance_properties — Create

Not implemented

PUT /api/v1/instance_properties — Update

Not implemented

PATCH /api/v1/instance_properties/:id — Patch

Not implemented

DELETE /api/v1/instance_properties/:id — Remove

Not implemented