Website logo
Docs
API Reference
Postman Collection
Release Notes
Navigate through spaces
⌘K
Overview
API Reference Overview
How to use the API 'Try It' feature
Apps And Solutions
Health
Application
Solution
Common
Authentication
Download OpenAPI file
Authentication And Authorization (AAA) Service
Role Management
User Management
Authentication
Connection Management
Group Management
File Management Service
Folders
Files
SDS Service
App
Vault
Data
Messaging Service
Introduction
Messages
Service Provider Management
Templates Management
Metering
Tenant Config Management
Notification Management
Mobile Push Notifications
App
App Notification
Event
Notification
Dispatch Service
Job Type
Job Workflow
Job
Job - Config
Dispatch Type
Dispatch
Mobile APIs
Dispatch - Config
Ledger
Ledger in batch
Custom Code Config
Participant Service
Tenant
Participant Type
Participant Type - Custom Code Config
Participant Type - Attributes Config
Participant Type - State Machine
Participant
Templates
Participant State
Participant - Batch Processing
Onboard
Container Service
Container Type
Container Type - Custom Code Config
Container Type - Attributes Config
Container Type - State Machine Config
Container
Container State
Container Group
Container - Batch Processing
Workflow Service
Execution Task
Changelog
Execution Macro
Execution Workflow
Execution Workflow Instance
Health Check
State Machine Service
State Machine Config
Entity
Events
Reasons
Instance State
Default Plugins
Job Manager
Work Order Manager
Container Manager
Workflow Manager
Cancellation Manager
Movement Tracking Service
Trace Data
Missing Sequence Numbers
Snapped Distance
Map Service Provider Management
Maps
ETA
Route
IOT Device
Geofence
MTS Subscription
Consent
Track
GPS Integration
MTS Metering
Settings
Events
Entity Service
Entity Type
State Machine Config
Entity Instance
Entity Type - Custom Code Config
Entity Instance State
Templates
Entity - Batch Processing
Onboard
Location Service
Location
Country
State
City
Search
Order Service
Order Config
Order State Machine Configuration
Order State Machine Transition
Work Order State Machine Configuration
Work Order State Transition
Order
Batch Order
Custom Code Config
Plugin Callback
External Reference APIs
Work Order Config
Work Order Status
Plugins
PluginWorkflow
User FPA
Users
File Upload
Designation
Groups
Config Management
Teams FPA
Teams
Filter API
Facility FPA
Facilities
Vehicle FPA
Vehicles
LogisticsOrder API
Order
Client Order APIs
Batch Order
Callback APIs
Tenant Init
AAA - External Authorizer
Authorization
Orchestrator
Plugins
PluginsV2
PluginWorkflow
Rules
RulesV2
DLQ Service
Query & Listing
Scheduler Service
Scheduler Service
Webhook Service
Apps
Events
Subscriptions
Attribute Alias API
POST
Create type with attribute aliases
PUT
Update type with attribute aliases
GET
Get all attribute aliases
Docs powered by Archbee
State Machine Service
Entity

Create Entity

1min
POST
https://{tenantSubDomain}.fxtrt.io/core/api/v1/state-machine/entities

This API will create an entity.

HTTP Status Code Summary

CodeDescription
200 - OKEverything worked as expected.
| **400 - Bad Request** | The request was unacceptable, often due to missing a required parameter. |
| **401 - Unauthorized** | No valid API key provided. |
| **503 - Server Errors** | Something went wrong on our end. (These are rare.) |
Header Parameters
X-COREOS-REQUEST-ID
string
*
X-COREOS-TID
string
*
X-COREOS-ACCESS
string
*
X-COREOS-USERINFO
string
Body Parameters
body
EntityCreateRequest
*
Description
Create entity
name
string
*
description
string
*
events
EventObject[]
*
isEnabled
boolean
entityCode
string
Responses
200
OK
SuccessResponse
All Of
ErrorResponse +
error
Error
*
request
Request
*
data
object
400
Bad request - The server is unable to process the request due to something that is perceived to be a client error.
ErrorResponse
error
Error
*
request
Request
*
401
Unauthorized - The client's identity is unknown to the server. Verify that you are accessing the correct tenant and that your client ID and client secret are valid on that Tenant.
ErrorResponse
error
Error
*
request
Request
*
503
Server error - The server is not ready to handle the request. This could be due to maintenance downtime or system resource constraints.
ErrorResponse
error
Error
*
request
Request
*




Updated 31 May 2024
Did this page help you?
PREVIOUS
Validate a state machine configuration
NEXT
Get All Entity
Docs powered by Archbee