Schemall API
Version 1.0.0
Universal HTTP API for vocabularies, schema catalogs, entity objects, lists, bookmarks, messages, reports, i18n, access, auth tokens, and icons.
Endpoints (122)
GET/api/v1/openapi
Get platform OpenAPI schema
Returns the universal Schemall OpenAPI document.
GET/api/v1/{vocabulary}/classes/{class}/openapi
Get classes entity OpenAPI schema
Returns an OpenAPI document for one schema entity.
GET/api/v1/{vocabulary}/classes/{class}
Get classes entity JSON Schema
POST/api/v1/{vocabulary}/classes/{class}/validate
Validate classes entity data
GET/api/v1/{vocabulary}/classes/{class}/i18n
Get classes entity lexical forms
PUT/api/v1/{vocabulary}/classes/{class}/i18n
Replace classes entity lexical forms
PATCH/api/v1/{vocabulary}/classes/{class}/i18n
Patch classes entity lexical forms
GET/api/v1/{vocabulary}/classes/{class}/access
List classes access grants
POST/api/v1/{vocabulary}/classes/{class}/access
Create classes access grant
PUT/api/v1/{vocabulary}/classes/{class}/access/{id}
Update classes access grant
PATCH/api/v1/{vocabulary}/classes/{class}/access/{id}
Patch classes access grant
DELETE/api/v1/{vocabulary}/classes/{class}/access/{id}
Delete classes access grant
GET/api/v1/{vocabulary}/classes/{class}/properties/{property}
Get classes property JSON Schema
GET/api/v1/{vocabulary}/classes/{class}/properties/{property}/types/{type}
Get classes property type JSON Schema
Leaf value schema for one expected property type (typed PropertyValueSpecification). Edit path is the typed PVS sheet; this endpoint is read-only compile output.
POST/api/v1/{vocabulary}/classes/{class}/properties/{property}/validate
Validate classes property value
GET/api/v1/{vocabulary}/classes/{class}/properties/{property}/i18n
Get classes property lexical forms
PUT/api/v1/{vocabulary}/classes/{class}/properties/{property}/i18n
Replace classes property lexical forms
PATCH/api/v1/{vocabulary}/classes/{class}/properties/{property}/i18n
Patch classes property lexical forms
GET/api/v1/{vocabulary}/classes/{class}/objects
List classes objects
POST/api/v1/{vocabulary}/classes/{class}/objects
Create classes object
GET/api/v1/{vocabulary}/classes/{class}/objects/count
Count classes objects
GET/api/v1/{vocabulary}/classes/{class}/objects/{id}
Get classes object
PUT/api/v1/{vocabulary}/classes/{class}/objects/{id}
Update classes object
PATCH/api/v1/{vocabulary}/classes/{class}/objects/{id}
Patch classes object
DELETE/api/v1/{vocabulary}/classes/{class}/objects/{id}
Delete classes object
GET/api/v1/{vocabulary}/classes/{class}/objects/{id}/v
List classes object versions
GET/api/v1/{vocabulary}/classes/{class}/lists
List classes ItemLists
GET/api/v1/{vocabulary}/classes/{class}/lists/count
Count classes ItemLists
GET/api/v1/{vocabulary}/classes/{class}/lists/{id}
Get classes ItemList
GET/api/v1/{vocabulary}/classes/{class}/lists/{id}/objects
List objects in a classes ItemList
GET/api/v1/{vocabulary}/classes/{class}/lists/{id}/objects/count
Count objects in a classes ItemList
GET/api/v1/{vocabulary}/enumerations/{enumeration}/openapi
Get enumerations entity OpenAPI schema
Returns an OpenAPI document for one schema entity.
GET/api/v1/{vocabulary}/enumerations/{enumeration}
Get enumerations entity JSON Schema
POST/api/v1/{vocabulary}/enumerations/{enumeration}/validate
Validate enumerations entity data
GET/api/v1/{vocabulary}/enumerations/{enumeration}/i18n
Get enumerations entity lexical forms
PUT/api/v1/{vocabulary}/enumerations/{enumeration}/i18n
Replace enumerations entity lexical forms
PATCH/api/v1/{vocabulary}/enumerations/{enumeration}/i18n
Patch enumerations entity lexical forms
GET/api/v1/{vocabulary}/enumerations/{enumeration}/access
List enumerations access grants
POST/api/v1/{vocabulary}/enumerations/{enumeration}/access
Create enumerations access grant
PUT/api/v1/{vocabulary}/enumerations/{enumeration}/access/{id}
Update enumerations access grant
PATCH/api/v1/{vocabulary}/enumerations/{enumeration}/access/{id}
Patch enumerations access grant
DELETE/api/v1/{vocabulary}/enumerations/{enumeration}/access/{id}
Delete enumerations access grant
GET/api/v1/{vocabulary}/enumerations/{enumeration}/properties/{property}
Get enumerations property JSON Schema
GET/api/v1/{vocabulary}/enumerations/{enumeration}/properties/{property}/types/{type}
Get enumerations property type JSON Schema
Leaf value schema for one expected property type (typed PropertyValueSpecification). Edit path is the typed PVS sheet; this endpoint is read-only compile output.
POST/api/v1/{vocabulary}/enumerations/{enumeration}/properties/{property}/validate
Validate enumerations property value
GET/api/v1/{vocabulary}/enumerations/{enumeration}/properties/{property}/i18n
Get enumerations property lexical forms
PUT/api/v1/{vocabulary}/enumerations/{enumeration}/properties/{property}/i18n
Replace enumerations property lexical forms
PATCH/api/v1/{vocabulary}/enumerations/{enumeration}/properties/{property}/i18n
Patch enumerations property lexical forms
GET/api/v1/{vocabulary}/enumerations/{enumeration}/objects
List enumerations objects
POST/api/v1/{vocabulary}/enumerations/{enumeration}/objects
Create enumerations object
GET/api/v1/{vocabulary}/enumerations/{enumeration}/objects/count
Count enumerations objects
GET/api/v1/{vocabulary}/enumerations/{enumeration}/objects/{id}
Get enumerations object
PUT/api/v1/{vocabulary}/enumerations/{enumeration}/objects/{id}
Update enumerations object
PATCH/api/v1/{vocabulary}/enumerations/{enumeration}/objects/{id}
Patch enumerations object
DELETE/api/v1/{vocabulary}/enumerations/{enumeration}/objects/{id}
Delete enumerations object
GET/api/v1/{vocabulary}/enumerations/{enumeration}/objects/{id}/v
List enumerations object versions
GET/api/v1/{vocabulary}/enumerations/{enumeration}/lists
List enumerations ItemLists
GET/api/v1/{vocabulary}/enumerations/{enumeration}/lists/count
Count enumerations ItemLists
GET/api/v1/{vocabulary}/enumerations/{enumeration}/lists/{id}
Get enumerations ItemList
GET/api/v1/{vocabulary}/enumerations/{enumeration}/lists/{id}/objects
List objects in a enumerations ItemList
GET/api/v1/{vocabulary}/enumerations/{enumeration}/lists/{id}/objects/count
Count objects in a enumerations ItemList
GET/api/v1/{vocabulary}/enummembers/{enumMember}/openapi
Get enummembers entity OpenAPI schema
Returns an OpenAPI document for one schema entity.
GET/api/v1/{vocabulary}/enummembers/{enumMember}
Get enummembers entity JSON Schema
POST/api/v1/{vocabulary}/enummembers/{enumMember}/validate
Validate enummembers entity data
GET/api/v1/{vocabulary}/enummembers/{enumMember}/i18n
Get enummembers entity lexical forms
PUT/api/v1/{vocabulary}/enummembers/{enumMember}/i18n
Replace enummembers entity lexical forms
PATCH/api/v1/{vocabulary}/enummembers/{enumMember}/i18n
Patch enummembers entity lexical forms
GET/api/v1/{vocabulary}/enummembers/{enumMember}/access
List enummembers access grants
POST/api/v1/{vocabulary}/enummembers/{enumMember}/access
Create enummembers access grant
PUT/api/v1/{vocabulary}/enummembers/{enumMember}/access/{id}
Update enummembers access grant
PATCH/api/v1/{vocabulary}/enummembers/{enumMember}/access/{id}
Patch enummembers access grant
DELETE/api/v1/{vocabulary}/enummembers/{enumMember}/access/{id}
Delete enummembers access grant
GET/api/v1/{vocabulary}/enummembers/{enumMember}/properties/{property}
Get enummembers property JSON Schema
GET/api/v1/{vocabulary}/enummembers/{enumMember}/properties/{property}/types/{type}
Get enummembers property type JSON Schema
Leaf value schema for one expected property type (typed PropertyValueSpecification). Edit path is the typed PVS sheet; this endpoint is read-only compile output.
POST/api/v1/{vocabulary}/enummembers/{enumMember}/properties/{property}/validate
Validate enummembers property value
GET/api/v1/{vocabulary}/enummembers/{enumMember}/properties/{property}/i18n
Get enummembers property lexical forms
PUT/api/v1/{vocabulary}/enummembers/{enumMember}/properties/{property}/i18n
Replace enummembers property lexical forms
PATCH/api/v1/{vocabulary}/enummembers/{enumMember}/properties/{property}/i18n
Patch enummembers property lexical forms
GET/api/v1/{vocabulary}/enummembers/{enumMember}/objects
List enummembers objects
POST/api/v1/{vocabulary}/enummembers/{enumMember}/objects
Create enummembers object
GET/api/v1/{vocabulary}/enummembers/{enumMember}/objects/count
Count enummembers objects
GET/api/v1/{vocabulary}/enummembers/{enumMember}/objects/{id}
Get enummembers object
PUT/api/v1/{vocabulary}/enummembers/{enumMember}/objects/{id}
Update enummembers object
PATCH/api/v1/{vocabulary}/enummembers/{enumMember}/objects/{id}
Patch enummembers object
DELETE/api/v1/{vocabulary}/enummembers/{enumMember}/objects/{id}
Delete enummembers object
GET/api/v1/{vocabulary}/enummembers/{enumMember}/objects/{id}/v
List enummembers object versions
GET/api/v1/{vocabulary}/enummembers/{enumMember}/lists
List enummembers ItemLists
GET/api/v1/{vocabulary}/enummembers/{enumMember}/lists/count
Count enummembers ItemLists
GET/api/v1/{vocabulary}/enummembers/{enumMember}/lists/{id}
Get enummembers ItemList
GET/api/v1/{vocabulary}/enummembers/{enumMember}/lists/{id}/objects
List objects in a enummembers ItemList
GET/api/v1/{vocabulary}/enummembers/{enumMember}/lists/{id}/objects/count
Count objects in a enummembers ItemList
GET/api/v1/auth/tokens
List API tokens
Lists scoped API tokens for the authenticated person.
POST/api/v1/auth/tokens
Create API token
DELETE/api/v1/auth/tokens/{id}
Revoke API token
GET/api/v1/icons
List MDI icons
GET/api/v1/icons/{icon-name}
Get MDI icon
GET/api/v1/icons/{icon-name}/content
Get MDI icon SVG
GET/api/v1/vocabularies
List vocabularies
POST/api/v1/vocabularies
Create vocabulary
GET/api/v1/vocabularies/{segment}
Get vocabulary by segment
PATCH/api/v1/vocabularies/{segment}
Update vocabulary
GET/api/v1/{vocabulary}/classes
List classes in a vocabulary
GET/api/v1/{vocabulary}/properties
List properties in a vocabulary
GET/api/v1/{vocabulary}/properties/{property}
Get standalone property JSON Schema
GET/api/v1/{vocabulary}/properties/{property}/types/{type}
Get standalone property type JSON Schema
Leaf value schema for one expected property type (typed PropertyValueSpecification).
GET/api/v1/{vocabulary}/enumerations
List enumerations in a vocabulary
GET/api/v1/{vocabulary}/enummembers
List enumeration members in a vocabulary
GET/api/v1/persons/{id}/organizations
List organizations for a person
POST/api/v1/organizations
Create organization
PATCH/api/v1/organizations/{id}
Update organization
GET/api/v1/organizations/{id}/members
List organization members
POST/api/v1/organizations/{id}/members
Add organization members
POST/api/v1/bookmarks/toggle
Toggle bookmark for a Thing
GET/api/v1/me/lists
List current person ItemLists
POST/api/v1/me/lists
Create ItemList for current person
GET/api/v1/me/lists/{id}
Get ItemList by id
PATCH/api/v1/me/lists/{id}
Update current person ItemList
DELETE/api/v1/me/lists/{id}
Delete current person ItemList
PUT/api/v1/me/lists/sync/{kind}/{id}
Sync Thing/Class/Property membership across owned lists
POST/api/v1/messages
Submit a contact message
POST/api/v1/reports
Submit a report action
GET/api/health
Health check
Liveness probe for containers and uptime monitors.