Jump to Content
OS1 Platform
DocsREST API ReferenceRelease Notes
Log InOS1 Platform
Log In
DocsREST API ReferenceRelease Notes

Introduction

  • Overview
  • Getting started with the OS1 Platform
  • Getting started with building Apps

Concepts

  • Console UI Overview

How-To Guides

  • Integrate with the Console
    • How to: Integrate your existing application with the Console UI
    • How to: Add a dropdown to the Console UI Header
  • Integrate with Participants
    • How to: Create a Participant Type
    • How to: Define Participant Attributes
    • How to: Create a Participant Template
    • How to: Configure the state machine
    • How to: Create the Participant
    • How to: Change the Participant State
    • How to: View the Participant change Logs
  • Integrate with Containers
    • How to: Create a Container type
    • How to: Create a Container
    • How to: Change the Container state
    • How to: Containerize a child Container
    • How to: View the Container change log
  • Integrate with Users
    • How To: Create a User
    • How to: Change State of a User
    • How to: Retrieve State of a User
    • How to: Retrieve a Designation
    • How to: Find the User ID of a User
    • How to: Update a User
  • Integrate with Vehicles
    • How to: Create a Vehicle
    • How to: Retrieve Vehicle Details
    • How to: Retrieve the State of a Vehicle
    • How to: Change State of a Vehicle
    • How to: Update a Vehicle
  • Integrate with Facilities
    • How to: Create a Property
    • How to: Retrieve Property
    • How to: Retrieve the State of a Property
    • How to: Change the State of a Property
    • How to: Update a Property
    • How to: Create a Facility
    • How to: Retrieve Facility
    • How to: Retrieve the State of a Facility
    • How to: Change the State of a Facility
    • How to: Update a Facility
  • Integrate with Entities
    • How to: Create an Entity Type
    • How to: Retrieve Entity Type
    • How to: Update Entity Type
    • How to: Retrieve Entity Type State
    • How to: Configure the State Machine for Entity type
    • How to: Update Entity Type State
    • How to: Create an Entity Template
    • How to: Retrieve Template
    • How to: Update Template
    • How to: Create the Entity
    • How to: Retrieve Entity
    • How to: Update Entity
    • How to: Retrieve Entity State
    • How to: Apply Event to an Entity
    • How to: View the Entity Change Logs
    • How to: Perform batch operation for Entity
  • Integrate with Dispatch
    • How to: Manage Job Type
    • How to: Manage Job Workflow
    • How to: Manage Jobs
    • How to: Manage Dispatch Type
    • How to: Manage Dispatch
    • How to: Manage Mobile APIs
    • How to: Manage Ledger

Logistics Framework

  • Overview
  • User API
    • Introduction to Users
    • Creating Users
  • Facility API
    • Property and Facility Attributes
    • Creating Property and Facility
    • Property and Facility Lifecycle
  • Vehicle API
    • Vehicle Attributes
    • Creating Vehicles
    • Vehicle Lifecycle
  • LogisticsOrder API
    • Predefined LogisticsOrder API Attributes
    • LogisticsOrder API Functionalities

Core APIs

  • Overview
  • Authentication And Authorization
  • Participant
  • Container
  • Dispatch
    • Jobs and Objectives
  • Workflow
    • Execution Task and Macro Payloads
  • Secure Data Storage
  • File Management
  • State Machine
  • Entity
  • Notification
  • Motion Tracking System
  • Location
  • Platform Order Management
    • Platform Order Attributes and Lifecycle
    • Work Order Attributes and Lifecycle
    • Order Validation and Enrichment Plugins
  • Address

Platform SDKs

  • SDK Overview
    • AAA SDK
    • Dispatch SDK
    • MTS SDK
    • Workflow Designer SDK

Sample Apps

  • Vehicle Management App
  • Container App
  • Tire Management App

Resources

  • FAQs
  • Glossary
  • Postman Collection
  • Introduction to Logistics
  • Event Sourcing
    • Introduction to Event Sourcing
    • Design Process
  • Entity, Event, and Reason Codes
  • UI Guidelines
    • User Interface Guidelines and Principles
    • WCAG Standards
    • Layouts, Grids, and Responsiveness
    • App Icons
    • Color
    • Typography
    • Buttons
    • Notifications
  • Service/API Level Error Codes
Powered by 

How to: Update Entity

Suggest Edits

For information about prerequisites, see Integrate with Entities.

To update an Entity, call the Update Entity endpoint and specify the entityId in the path parameter.

Updated 3 months ago