PUT V2/odata/EntityState({key})

Updates EntityState entity

Request Information

URI Parameters

NameDescriptionTypeAdditional information
key

EntityStateId from EntityState entity

integer

Required

Body Parameters

QicsUnity.Api.Areas.V2.Models.EntityState
NameDescriptionTypeAdditional information
EntityStateId

Gets or sets unique ID

integer

Required

64-bit signed integer

CompanyId

Gets or sets the reference to Company table

integer

Required

64-bit signed integer

EntityId

Gets or sets ID of the entity on which the state is reported

integer

64-bit signed integer

EntityType

Gets or sets type of the entity on which the state is reported

QicsUnity.Api.Areas.V2.Models.EntityType

DataSource

Gets or sets identifier of the source that reported entity state

string

Required

DataSourceKey

Gets or sets entity identifier in the source system

string

DataSourceDate

Gets or sets entity state change date in the source system

date

Required

date and time of day, relative to Coordinated Universal Time (UTC)

IsError

Gets or sets a value indicating whether entity state represents error

boolean

Required

Message

Gets or sets optional entity state message

string

Request Formats

application/json, text/json

Sample:
{
  "EntityStateId": "1",
  "CompanyId": "2",
  "EntityId": "3",
  "EntityType": "General",
  "DataSource": "sample 4",
  "DataSourceKey": "sample 5",
  "DataSourceDate": "2024-03-28T13:12:40.7289406+00:00",
  "IsError": true,
  "Message": "sample 8"
}

application/xml, text/xml

Sample:
<EntityState xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/QicsUnity.Api.Areas.V2.Models">
  <CompanyId>2</CompanyId>
  <DataSource>sample 4</DataSource>
  <DataSourceDate xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
    <d2p1:DateTime>2024-03-28T13:12:40.7289406Z</d2p1:DateTime>
    <d2p1:OffsetMinutes>0</d2p1:OffsetMinutes>
  </DataSourceDate>
  <DataSourceKey>sample 5</DataSourceKey>
  <EntityId>3</EntityId>
  <EntityStateId>1</EntityStateId>
  <EntityType>General</EntityType>
  <IsError>true</IsError>
  <Message>sample 8</Message>
</EntityState>

Response Information

Resource Description

QicsUnity.Api.Areas.V2.Models.EntityState
NameDescriptionTypeAdditional information
EntityStateId

Gets or sets unique ID

integer

Required

64-bit signed integer

CompanyId

Gets or sets the reference to Company table

integer

Required

64-bit signed integer

EntityId

Gets or sets ID of the entity on which the state is reported

integer

64-bit signed integer

EntityType

Gets or sets type of the entity on which the state is reported

QicsUnity.Api.Areas.V2.Models.EntityType

DataSource

Gets or sets identifier of the source that reported entity state

string

Required

DataSourceKey

Gets or sets entity identifier in the source system

string

DataSourceDate

Gets or sets entity state change date in the source system

date

Required

date and time of day, relative to Coordinated Universal Time (UTC)

IsError

Gets or sets a value indicating whether entity state represents error

boolean

Required

Message

Gets or sets optional entity state message

string

Response Formats

application/json, text/json

Sample:
{
  "EntityStateId": "1",
  "CompanyId": "2",
  "EntityId": "3",
  "EntityType": "General",
  "DataSource": "sample 4",
  "DataSourceKey": "sample 5",
  "DataSourceDate": "2024-03-28T13:12:40.7289406+00:00",
  "IsError": true,
  "Message": "sample 8"
}

application/xml, text/xml

Sample:
<EntityState xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/QicsUnity.Api.Areas.V2.Models">
  <CompanyId>2</CompanyId>
  <DataSource>sample 4</DataSource>
  <DataSourceDate xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
    <d2p1:DateTime>2024-03-28T13:12:40.7289406Z</d2p1:DateTime>
    <d2p1:OffsetMinutes>0</d2p1:OffsetMinutes>
  </DataSourceDate>
  <DataSourceKey>sample 5</DataSourceKey>
  <EntityId>3</EntityId>
  <EntityStateId>1</EntityStateId>
  <EntityType>General</EntityType>
  <IsError>true</IsError>
  <Message>sample 8</Message>
</EntityState>