Developer Documentation
Digital Vault Styleguide
Apollo
Get Transaction Status
Schema Registry
Create a new schema
Get schema by Id
Get schema by collection id
Get schema by Id and Version
Get schema by state
Get All schema
Get All schema titles
Create Schema Collection
Get schema by collection id and tag
Get list of collection id
Delete a schema collection
Validate object against schema
Publish schema
Get schema, all versions
Create Hierarchy
Get Hierarchy
Get count of schemas per collection id
Get Metadata
Get Systemdata
Invalidate Cache
Delete a schema
Get Rules For Entity
Get Rules For Relationship
validate Ontology
Create a sample Object
Create a sample object for a specific version
Get a sample Object
Get a sample Object for Specific Version
Sync schemas
Device
Post Device
Timeseries
Post Timeseries
Post Samples
Get Timeseries
Get Samples
ER Service
GET all entities
GET a specific Entity by EntityId
GET all Relationships
GET Relation by RelationId
GET all Entities of a specific EntityType
GET all Relations of a specific RelationshipType
Get ER Stats by ER Collection ID
Post Entities (Synchronously)
Post Entities (Asynchronously)
Post Relationships (Synchronously)
Post Relationships (Asynchronously)
POST Relationships Sync to ERService API across ERCollections (Synchronously)
Post Entities From CSV OR JSON File (Synchronously)
Post Relationships from CSV OR JSON file (Synchronously)
GET a specific file Entity by EntityId
GET File Metadata by File Name
Event Service
GET all Events
GET a specific Event by EntityId
Graph
Get All Entities
Get All Relationships
Get All Entities By EntityType
Get Entity By EntityID
Get Relationship By RelationshipID
Get Entities By EntityIDs
Get All Entities and Relationships By Source EntityId
Get All Relationships By Relationship Type
Get One Level Expansion of ER
Get Two Level Expansion of ER
Search Entities
Search Relationships
Ontology
Get all Relations of a specific RelationshipType
Get Ontology Object by EntityType
Post All EntityTypes (Async)
Post All RelationshipTypes (Async)
Status
Get Status By Logs
Get Status by Transaction Id
Get Status by Collection ID
Get Status by ER Collection Id
Get Status by Entity Id
Get Status by Relationship Id
Files
Upload File
Download a Media File
Download Media by Version
Download Metadata
Download Metadata by version
Copy File
Delete File
Track File
Change Feed
Get Change Feed Notifications
Subscribe to Change Feed Notifications
Messaging Service
Create topic
Update Topic
Delete Topic
Get Topic
Get List Of Topics
Get Topic List By Principle
Get Topic List By Relation
Register a user to topic
Un-register a user to topic
Post message to a Topic
Get Batch of Messages
Zeus
Access Control Level
Get ACL
Post ACL
Post Additional Permission
Put ACL
Delete ACL
Delete All Permission for Single Principal
Delete Single Permission
IMS API
Get Token
Validate Token
Refresh Token
Get Well Known/OpenID Configuration
Security API
Users API
Create User
Get User
Update User
Delete User
Get All Users
Get User Devices
Get User Groups
Link Device
Unlink Device
Link Group
Unlink Group
Devices API
Create / Register Device
Get Device
Update Device
Delete Device
Get All Devices
Get Linked Device Users
Get Device Groups
Get Device Types
Get Device for Another User
Post Device ACL
Get Device ACL
Delete Device ACL
Link User
Unlink User
Link Org
Unlink Org
Link Group
Unlink Group
Get Device Shadow
Update Shadow
Delete Shadow
Roles API
Create Role
Get Role
Update Role
Delete Role
Get All Roles
Groups API
Create Group
Get Group
Delete Group
Get All Groups
Get Group Devices
Get Group Users
Link Device to Group
Unlink Device from Group
Link User to Group
Unlink User from Group
Transport API
Post Command to Device
Post Message to Device
Subscription API
Add a New Subscription
Delete Subscription
Get Subscription
Overwrite an Existing Subscription
Subscription Connection API
Add a New Subscription Connection
Get Subscription Connection
Delete Subscription Connection
Get Subscription for Subscriber
Access Control List
Get Access Control List
Overwrite an Existing Access Control List
Add a New Permission to an Already Existing Access Control List
Delete Principal
Delete Any Permissions
Subscription Topic API
Add a New Subscription Topic
Get Subscription Topic
Delete Subscription Topic
Topic Access Control List
Get Topic Access Control List
Overwrite an Existing Access Control List
Add a new Permission to Existing Access Control list
Delete Permission
Delete Any Permissions
Subscription Type API
Add a New Subscription Type
Get Subscription Type
Delete Subscription Type
Type Access Control List
Get Type Access Control List
Overwrite an Existing Access Control List
Add a new Permission to Existing Access Control list
Delete the Permission
Delete Any Permissions
Entity API
Post Entities
Get Entities
Delete Entities
Timeseries API
Definitions
Operations/Metrics
Check API Health
Perform Operations/Metrics
Timeseries API overview
Request New Timeseries
Register New Timeseries Definition
Add or Update Metrics
Read Timeseries
Get Metrics
Bulk Register Timeseries
Get Timeseries Statistic
Timeseries Statistics for Multiple IDs
Delete Metrics
Set Timeseries Status
Delete Timeseries Status
Access Control List
Get ACL
Post ACL Permission
Put ACL
Delete ACL All Permissions
Delete ACL Permission for a Principal
Samples
Post Samples to ID
Post Samples to Multiple IDs
Generate Samples
Get Samples for Timeseries ID
Get Samples from Multiple IDs
Sample Pagination
Get Last N Samples
Get Sample Count
Get Daily Sample Count
Delete Sample By Id
Delete Samples for a Timeseries ID
Delete Samples By List
Delete Samples By Range
PSR Status
Get Status for PSR ID
Org (Deprecated)
Post Org (Deprecated)
Add List To Org (Deprecated)
Get Org Samples (Deprecated)
Get Org Timeseries IDs (Deprecated)
Get Org (Deprecated)
Weather API
Weather Status
Accu Weather
Get Hourly Forecast
Get Daily Forecast
Get Consolidated Forecast
Aeris Weather
Aeris Get Forecast
Get Observation/Archive
BreezoMeter Weather
Get Air Quality Index
OpenWeather
Get Forecasts
Nitrogen Dioxide Pollution
Carbon Monoxide Pollution
Ozone Pollution
Sulfur Dioxide Pollution
Time Sync
Event Service Overview
This service provides the capability to retrieve event objects.