Skip to main content
Version: v5.3

Application Ontology Service REST API

Use the Application Ontology Service REST API to interface with the Application Ontology Service by making HTTP requests to the endpoints in the table below. All paths are relative to /aosvc/api/v1.

Note: Click any endpoint to go to its API reference page.

EndpointRequest scope
/ontologiesCreate and manage the application ontology for a namespace, control its edit lock, and move it through drafts, versions, and promotion.
/ontologies/{ontologyId}/classesCreate, update, retrieve, and delete the classes of an ontology, and read a class's effective schema.
/ontologies/{ontologyId}/relationships, /rulesDeclare which classes can relate to each other, and add rules to an ontology.
/ontologies/{ontologyId}/constraintsAdd the rules that individuals of a class must meet.
/ontologies/{ontologyId}/actionsCreate and manage actions that state machine transitions run.
/ontologies/{ontologyId}/state-machinesCreate and manage state machines, fire events against individuals, and check the actions that transitions ran.
/classes/{classId}/mappingBind a class to the Item Service collection that stores its individuals.
/classes/{classId}/individualsCreate, read, search, update, and delete individuals of a class.
/classes/{classId}/individuals/relationshipsAdd, replace, read, and remove relationships between individuals.
/classes/{classId}/individuals/readingsRecord and read time-stamped readings for individuals of a telemetry class.
/ontologies/{ontologyId}/import, /async-tasksImport individuals of many classes in one request, and poll queued tasks.
/permissionsRead, grant, and revoke access to ontologies and to the individuals of ontology classes.
/ontologies/{ontologyId}/impact-analysis-reportsSee what would change if a version of an ontology replaced the live version.
/reasoner, /source/owlRun reasoning over data in the request, and preview OWL documents.
/ontologies/{ontologyId}/ai, /classes/{classId}/mcp-configUse the AI Service to help build an ontology, and declare a class as an MCP tool.