Website logo
Docs
API Reference
Postman Collection
Release Notes
Navigate through spaces
⌘K
Introduction
Overview
Getting started with the OS1 Platform
Getting started with building Apps
Concepts
Working with Callbacks
Console UI Overview
Custom Code
Working with GraphQL
Custom Attributes Ownership
Attribute-Based Access Control (ABAC)
Data Listing and Query (DLQS) Search
Core API dev guides
Overview
Authentication And Authorization
Participant
Container
Dispatch
Orchestrator
Workflow
Secure Data Storage
File Management
State Machine
Entity
Notification
Motion Tracking System
Location
Platform Order Management
Address
Scheduler
Logistics Framework API Dev guides
Overview
LogisticsOrder API
User API
Facility API
Vehicle API
How-To Guides
Integrate Your Application with Console UI
Integrate with Participants
Integrate with Containers
Integrate with Users
Integrate with Vehicles
Integrate with Facilities
Integrate with Entities
Integrate with Dispatch
Integrate with Logistics Order
Integrate with Platform Order Management
Integrate with Location Service
Integrate with Orchestrator
GraphQl Schemas
GraphQL: Dispatch Queries
GraphQL: Order Queries
GraphQL: Workflow Queries
GraphQL: Container Queries
Platform SDKs
SDK Overview
Sample Apps
Vehicle Management App
Container App
Resources
FAQs
Glossary
Data Types Used in OS1
Development Guidelines
Entity, Event, and Reason Codes
Service/API Level Error Codes
Docs powered by Archbee
How-To Guides

Integrate with Entities

2min

The following how-to sections describe the steps necessary to create and manage Entities using the Entity API.



To create an Entity, you must:

  • Create an Entity type. For more information, see How to: Create an Entity Type.
  • Configure the state machine for the Entity type. For more information, see How to: Configure the State Machine for Entity type.
  • Define the Entity Templates. For more information, see How to: Create an Entity Template
  • Create an Entity. For more information, see How to: Create the Entity
  • Create/Update Entities in Batch. For more information, see How To: Create & Update Entities In Batch

Additionally, you can:

  • Retrieve Entity type. For more information, see How to: Retrieve Entity Type.
  • Update Entity type. For more information, see How to: Update Entity Type.
  • Retrieve Entity type state. For more information, see How to: Retrieve Entity Type State
  • Update Entity type state. For more information, see How to: Update Entity Type State
  • Retrieve Entity. For more information, see How to: Retrieve Entity.
  • Update Entity. For more information, see How to: Update Entity.
  • Retrieve Entity state. For more information, see How to: Retrieve Entity State.
  • Apply event to Entity. For more information, see How to: Apply Event to an Entity.
  • Retrieve Template. For more information, see How to: Retrieve Template.
  • Update Template. For more information, see How to: Update Template.
  • Handle Callbacks. For more information, see Working with Callbacks.



Updated 03 Aug 2023
Did this page help you?
PREVIOUS
How to: Update a Facility
NEXT
How to: Create an Entity Type
Docs powered by Archbee
TABLE OF CONTENTS
Prerequisites
Docs powered by Archbee