Create Entity

1min

POST
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
*
Unique requestId
X-COREOS-TID
string
*
Tenant id
X-COREOS-ACCESS
string
*
core-os access token
X-COREOS-USERINFO
string
core-os user info token
BODY PARAMETERS
body
EntityCreateRequest
*
Create entity
name
string
*
Name of the entity.
description
string
*
Short description of the event. Max length 64 characters.
events
EventObject[]
*
List of valid events that can be applied on this entity
isEnabled
boolean
True - Entity Code is valid & usable. False - Entity Code is not usable
entityCode
string
Code of the entity.
RESPONSES
200
OK
SuccessResponse
[All Of:ErrorResponseobject]
error
Error
*
Error Information
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
*
Error Information
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
*
Error Information
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
*
Error Information
request
Request
*
﻿
﻿

Code	Description
200 - OK	Everything worked as expected.

Updated 21 Sep 2023

Did this page help you?

Validate a state machine configuration

Get All Entity