Acrobase APIs
Documentation
Base
API version:
Select which version of the API to use, choices:
v1
Archetype Hierarchy API (REST)
Endpoint for retrieving the list of families:
GET /v1/archetype_hierarchy
name:
This param set the name for the archetype hierarchy (returns list of archetype within this archetype hierarchy).
Request example:
/v1/archetype_hierarchy
Archetype API (REST)
Endpoint for retrieving the archetype specifications:
GET /v1/archetype
acronym:
This param set the identifier for the archetype.
include:
space-separated list of data to include. Options: materials elements fields
Request example:
/v1/archetype?acronym=TH&include=design elements materials fields
Materials API (REST)
Endpoint for retrieving the materials specifications:
GET /v1/materials
expand_aliases
Copies unpopulated data from base materials to aliases.
verbose
Includes all materials data fields, not just those required for documentation.
Request example:
/v1/materials
Fields API (REST)
Endpoint for retrieving the fields specifications:
GET /v1/fields
archetype
archetype for which to retrieve fields. If empty, retrieve all fields.
level
field level to include (e.g. 'asset', 'archetype'), if empty, return all fields.
Request example:
/v1/fields