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

How to: Create an Entity Type

1min

For information about prerequisites, see Integrate with Entities.

To create an Entity Type, call the Create Entity Type endpoint and pass a request body similar to the following:

JSON
{
   "name":{
      "plural":"vehicles",
      "singular":"vehicle"
   },
   "category":[
      {
         "name":"four-wheeler",
         "description":"four-wheeler vehicle",
         "subCategory":[
            "bus",
            "car",
            "truck"
         ]
      }
   ],
   "attributes":[
      {
         "name":"manufacturer",
         "dataType":"string",
         "indexed":false
        
      }
   ],
   "isStateMachineEnabled":true,
     "events": [
    "string"
  ]
}


In the above payload, we have created an Entity type with the plural name vehicles. This Entity type has a category called four-wheeler and three sub-categories. The payload also has core attributes defined.

Updated 16 Aug 2023
Did this page help you?
PREVIOUS
Integrate with Entities
NEXT
How to: Retrieve Entity Type
Docs powered by Archbee
Docs powered by Archbee