GET V3/odata/OverviewEntityState
Gets OverviewEntityState entities
Request Information
URI Parameters
None.
Body Parameters
None.
Response Information
Resource Description
Collection of QicsUnity.Api.Areas.V3.Models.OverviewEntityStateName | Description | Type | Additional information |
---|---|---|---|
EntityStateId |
Gets or sets unique ID |
integer |
64-bit signed integer |
CompanyId |
Gets or sets the reference to Company table |
integer |
64-bit signed integer Nullable |
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.V3.Models.EntityType |
None. |
DataSource |
Gets or sets identifier of the data source that reported entity state |
string |
None. |
DataSourceKey |
Gets or sets entity identifier in the data source system |
string |
None. |
DataSourceDate |
Gets or sets entity state change date in the data source system |
date |
date and time of day, relative to Coordinated Universal Time (UTC) |
IsError |
Gets or sets a value indicating whether entity state represents error |
boolean |
None. |
Message |
Gets or sets optional entity state message |
string |
None. |
Response Formats
application/json, text/json
Sample:
[ { "EntityStateId": "1", "CompanyId": "1", "EntityId": "2", "EntityType": "General", "DataSource": "sample 3", "DataSourceKey": "sample 4", "DataSourceDate": "2024-12-22T17:10:04.7933966+00:00", "IsError": true, "Message": "sample 7" }, { "EntityStateId": "1", "CompanyId": "1", "EntityId": "2", "EntityType": "General", "DataSource": "sample 3", "DataSourceKey": "sample 4", "DataSourceDate": "2024-12-22T17:10:04.7933966+00:00", "IsError": true, "Message": "sample 7" } ]
application/xml, text/xml
Sample:
<ArrayOfOverviewEntityState xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/QicsUnity.Api.Areas.V3.Models"> <OverviewEntityState> <CompanyId>1</CompanyId> <DataSource>sample 3</DataSource> <DataSourceDate xmlns:d3p1="http://schemas.datacontract.org/2004/07/System"> <d3p1:DateTime>2024-12-22T17:10:04.7933966Z</d3p1:DateTime> <d3p1:OffsetMinutes>0</d3p1:OffsetMinutes> </DataSourceDate> <DataSourceKey>sample 4</DataSourceKey> <EntityId>2</EntityId> <EntityStateId>1</EntityStateId> <EntityType>General</EntityType> <IsError>true</IsError> <Message>sample 7</Message> </OverviewEntityState> <OverviewEntityState> <CompanyId>1</CompanyId> <DataSource>sample 3</DataSource> <DataSourceDate xmlns:d3p1="http://schemas.datacontract.org/2004/07/System"> <d3p1:DateTime>2024-12-22T17:10:04.7933966Z</d3p1:DateTime> <d3p1:OffsetMinutes>0</d3p1:OffsetMinutes> </DataSourceDate> <DataSourceKey>sample 4</DataSourceKey> <EntityId>2</EntityId> <EntityStateId>1</EntityStateId> <EntityType>General</EntityType> <IsError>true</IsError> <Message>sample 7</Message> </OverviewEntityState> </ArrayOfOverviewEntityState>