Integrate with Entities

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

Prerequisites

• An account on the OS1 Platform and a Platform Tenant. For more information, see Getting started with the OS1 Platform.
• Credentials for an App on the OS1 Platform. For more information, see Getting started building Apps.
• An access token. For more information about creating an access token for testing purposes, see Postman Collection or How to use the API 'Try It' feature.
• A mechanism to call the endpoints. For testing purposes, you can use our Postman Collection or the “Try It!” feature in our API Documentation.

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 the Entity type.
• Define the Entity Templates. For more information, see How to: Create an Entity Template.
• Create the Entity. For more information, see How to: Create the Entity.

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.
• View the Entity change log. For more information, see How to: View the Entity change logs.
• Perform batch operations for creating, updating, and retrieving Entities. For more information, see How to: Perform batch operation for Entity.