AirConditioning Entity
: Asset
- Asset created from a material of type air conditioning, entity inheriting the Nlyte.Model.Asset entity
Verb(s) | Required Permission(s) | Link | Description |
---|
Get | WS-ReadAirConditioning | integration/api/odata/AirConditionings, integration/api/odata/AirConditionings({key}) | |
Patch | WS-ModifyAirConditioning | integration/api/odata/AirConditionings({key}) | |
Delete | WS-ModifyAirConditioning | integration/api/odata/AirConditionings({key}) | |
PostWithKey | WS-ModifyAirConditioning | integration/api/odata/AirConditionings({key}) | |
Post | WS-AddAirConditioning | integration/api/odata/AirConditionings | |
AirConditioning Structural Properties
Property | Type | Nullable | Mandatory | Read-Only | String length | Min Value | Max Value | Precision | Max Dec Places | Is Only Date | Description |
---|
AuditDate | Edm.DateTimeOffset | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
AuditStatusCorrect | Edm.Boolean | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
LastAuditorAccountID | Edm.Int32 | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
ManufactureDate | Edm.DateTimeOffset | true | false |
false
| N/A | N/A | N/A | N/A | N/A | IsOnlyDate | |
ServiceDate | Edm.DateTimeOffset | true | false |
false
| N/A | N/A | N/A | N/A | N/A | IsOnlyDate | |
TotalPlugs | Edm.Int32 | false | false |
true
| N/A | N/A | N/A | N/A | N/A | | |
AirConditioning Navigational Properties
Verb(s) | Required Permission(s) | Link | Description |
---|
Get | WS-ReadAirConditioningMaterial | integration/api/odata/AirConditioningMaterials, integration/api/odata/AirConditioningMaterials({key}) | |
Post | WS-AddAirConditioningMaterial | integration/api/odata/AirConditioningMaterials | |
PostWithKey | WS-ModifyAirConditioningMaterial | integration/api/odata/AirConditioningMaterials({key}) | |
Patch | WS-ModifyAirConditioningMaterial | integration/api/odata/AirConditioningMaterials({key}) | |
Delete | WS-ModifyAirConditioningMaterial | integration/api/odata/AirConditioningMaterials({key}) | |
AirConditioningMaterial Structural Properties
Property | Type | Nullable | Mandatory | Read-Only | String length | Min Value | Max Value | Precision | Max Dec Places | Is Only Date | Description |
---|
AirConditioningFlowDirectionID | Nlyte.Model.AirConditioningFlowDirectionEnum | false | true |
false
| N/A | N/A | N/A | N/A | N/A | | |
CalculatedMpafPowerConsumption | Edm.Decimal | true | false |
true
| N/A | N/A | N/A | N/A | N/A | | Read-only property, value provided by the service based on the PublishedPowerConsumption and the MpafOverride |
ConsumerPowerFactor | Edm.Decimal | false | false |
true
| N/A | N/A | N/A | N/A | N/A | | Read-only property representing the percentage of power drawn by a PDD material that is available to its asset consumers |
MaterialCategoryID | Edm.Int32 | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
MpafOverride | Edm.Decimal | true | false |
false
| N/A | 0.001 | 999 | 6 | 3 | | Value inserted by the user, while the material is in Planned status |
NominalCooling | Edm.Double | false | false |
false
| N/A | 0 | 999999999999.999 | 15 | 3 | | |
PowerTypeID | Nlyte.Model.PowerTypeEnum | false | true |
false
| N/A | N/A | N/A | N/A | N/A | | Power type: phased or direct current |
PublishedPowerConsumption | Edm.Decimal | false | false |
false
| N/A | 0.001 | 999 | 6 | 3 | | Value inserted by the user, while the material is in Planned status |
RequiredPlugs | Edm.Int32 | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | Value inserted by the user, while the material is in Planned status |
RequiresDiversePower | Edm.Boolean | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | Value available to be updated by the user only if RequiredPlugs TotalPlugs |
TotalPlugs | Edm.Int32 | false | true |
false
| N/A | N/A | N/A | N/A | N/A | | Value inserted by the user, while the material is in Planned status |
UHeight | Edm.Int64 | false | false |
true
| N/A | N/A | N/A | N/A | N/A | | |
WorkableFootPrintFront | Edm.Double | false | false |
false
| N/A | 0 | 999999999999.9999 | 16 | 4 | | |
WorkableFootPrintHeight | Edm.Double | false | false |
false
| N/A | 0 | 999999999999.9999 | 16 | 4 | | |
WorkableFootPrintRear | Edm.Double | false | false |
false
| N/A | 0 | 999999999999.9999 | 16 | 4 | | |
AirConditioningMaterial Navigational Properties
Verb(s) | Required Permission(s) | Link | Description |
---|
Key(s) |
---|
ChildLocationGroupID |
AncestralInfo Structural Properties
Property | Type | Nullable | Mandatory | Read-Only | String length | Min Value | Max Value | Precision | Max Dec Places | Is Only Date | Description |
---|
Building | Edm.String | true | false |
true
| 150 | N/A | N/A | N/A | N/A | | |
ChildLocationGroupID | Edm.Int32 | false | |
false
| | | | | | | |
City | Edm.String | true | false |
true
| 150 | N/A | N/A | N/A | N/A | | |
Country | Edm.String | true | false |
true
| 150 | N/A | N/A | N/A | N/A | | |
County | Edm.String | true | false |
true
| 150 | N/A | N/A | N/A | N/A | | |
Floor | Edm.String | true | false |
true
| 150 | N/A | N/A | N/A | N/A | | |
Region | Edm.String | true | false |
true
| 150 | N/A | N/A | N/A | N/A | | |
Room | Edm.String | true | false |
true
| 150 | N/A | N/A | N/A | N/A | | |
AncestralInfo Navigational Properties
No navigational properties
Verb(s) | Required Permission(s) | Link | Description |
---|
Get | WS-ReadRoomPlan | | |
Patch | WS-ModifyRoomPlan | | |
Put | WS-ModifyRoomPlan | | |
Delete | WS-ModifyRoomPlan | | |
Post | WS-ModifyRoomPlan | | |
Anchor Structural Properties
Property | Type | Nullable | Mandatory | Read-Only | String length | Min Value | Max Value | Precision | Max Dec Places | Is Only Date | Description |
---|
ID | Edm.Int32 | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
SaveAction | Nlyte.Model.SaveActionEnum | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
X | Edm.Decimal | false | false |
false
| N/A | 0 | 9999999.999 | 10 | 3 | | |
Y | Edm.Decimal | false | false |
false
| N/A | 0 | 9999999.999 | 10 | 3 | | |
Anchor Navigational Properties
No navigational properties
Verb(s) | Required Permission(s) | Link | Description |
---|
Get | WS-ReadRoomPlan | | |
Patch | WS-ModifyRoomPlan | | |
Put | WS-ModifyRoomPlan | | |
Delete | WS-ModifyRoomPlan | | |
Post | WS-ModifyRoomPlan | | |
Area Structural Properties
Property | Type | Nullable | Mandatory | Read-Only | String length | Min Value | Max Value | Precision | Max Dec Places | Is Only Date | Description |
---|
AreaStatusID | Edm.Int32 | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
AreaTypeId | Nlyte.Model.AreaType | false | true |
false
| N/A | N/A | N/A | N/A | N/A | | |
AreaUsageID | Edm.Int32 | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
CabinetForecastNumber | Edm.Int32 | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
ConsumesFloorSpace | Edm.Boolean | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
CoolingLimit | Edm.Decimal | true | false |
false
| N/A | 0 | 9999999.999 | 10 | 3 | | |
CoolingMaximum | Edm.Decimal | true | false |
false
| N/A | 0 | 9999999.999 | 10 | 3 | | |
CoolingThreshold | Edm.Decimal | true | false |
false
| N/A | 0 | 9999999.999 | 10 | 3 | | |
EndDate | Edm.DateTimeOffset | true | false |
false
| N/A | N/A | N/A | N/A | N/A | IsOnlyDate | |
HeatLimit | Edm.Decimal | true | false |
false
| N/A | 0 | 9999999.999 | 10 | 3 | | |
HeatMaximum | Edm.Decimal | true | false |
false
| N/A | 0 | 9999999.999 | 10 | 3 | | |
HeatThreshold | Edm.Decimal | true | false |
false
| N/A | 0 | 9999999.999 | 10 | 3 | | |
LocationGroupID | Edm.Int32 | true | false |
true
| N/A | N/A | N/A | N/A | N/A | | Foreign key identifying the location |
Name | Edm.String | true | true |
false
| 150 | N/A | N/A | N/A | N/A | | Area Name. This must be unique for a Room. |
NominalPower | Edm.Decimal | true | false |
false
| N/A | 0 | 9999999.999 | 10 | 3 | | |
RoomId | Edm.Int32 | true | false |
true
| N/A | N/A | N/A | N/A | N/A | | |
RoomLocationGroupId | Edm.Int32 | false | false |
true
| N/A | N/A | N/A | N/A | N/A | | |
StartDate | Edm.DateTimeOffset | true | false |
false
| N/A | N/A | N/A | N/A | N/A | IsOnlyDate | |
UsedArea | Edm.Decimal | false | false |
true
| N/A | N/A | N/A | N/A | N/A | | |
WeightLimit | Edm.Decimal | true | false |
false
| N/A | 0 | 9999999.9999 | 11 | 4 | | |
WeightMaximum | Edm.Decimal | true | false |
false
| N/A | 0 | 9999999.9999 | 11 | 4 | | |
WeightThreshold | Edm.Decimal | true | false |
false
| N/A | 0 | 9999999.9999 | 11 | 4 | | |
Area Navigational Properties
Verb(s) | Required Permission(s) | Link | Description |
---|
Get | WS-ReadRoomPlan | | |
Patch | WS-ModifyRoomPlan | | |
Put | WS-ModifyRoomPlan | | |
Delete | WS-ModifyRoomPlan | | |
Post | WS-ModifyRoomPlan | | |
AreaBusinessGroupMap Structural Properties
Property | Type | Nullable | Mandatory | Read-Only | String length | Min Value | Max Value | Precision | Max Dec Places | Is Only Date | Description |
---|
AreaMarkerID | Edm.Int32 | true | false |
true
| N/A | N/A | N/A | N/A | N/A | | |
BusinessGroupID | Edm.Int32 | true | true |
false
| N/A | N/A | N/A | N/A | N/A | | |
EndDate | Edm.DateTimeOffset | true | false |
false
| N/A | N/A | N/A | N/A | N/A | IsOnlyDate | |
ID | Edm.Int32 | false | true |
false
| N/A | N/A | N/A | N/A | N/A | | |
StartDate | Edm.DateTimeOffset | true | false |
false
| N/A | N/A | N/A | N/A | N/A | IsOnlyDate | |
AreaBusinessGroupMap Navigational Properties
Verb(s) | Required Permission(s) | Link | Description |
---|
Get | WS-ReadRoomPlan | | |
Patch | WS-ModifyRoomPlan | | |
Put | WS-ModifyRoomPlan | | |
Delete | WS-ModifyRoomPlan | | |
Post | WS-ModifyRoomPlan | | |
AreaStatus Structural Properties
Property | Type | Nullable | Mandatory | Read-Only | String length | Min Value | Max Value | Precision | Max Dec Places | Is Only Date | Description |
---|
Description | Edm.String | false | true |
false
| 100 | N/A | N/A | N/A | N/A | | |
ID | Edm.Int32 | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
AreaStatus Navigational Properties
No navigational properties
Verb(s) | Required Permission(s) | Link | Description |
---|
Get | WS-ReadRoomPlan | | |
Patch | WS-ModifyRoomPlan | | |
Put | WS-ModifyRoomPlan | | |
Delete | WS-ModifyRoomPlan | | |
Post | WS-ModifyRoomPlan | | |
AreaSupportGroupMap Structural Properties
Property | Type | Nullable | Mandatory | Read-Only | String length | Min Value | Max Value | Precision | Max Dec Places | Is Only Date | Description |
---|
AreaMarkerID | Edm.Int32 | true | false |
true
| N/A | N/A | N/A | N/A | N/A | | |
ID | Edm.Int32 | false | true |
false
| N/A | N/A | N/A | N/A | N/A | | |
SupportGroupID | Edm.Int32 | true | true |
false
| N/A | N/A | N/A | N/A | N/A | | |
AreaSupportGroupMap Navigational Properties
Verb(s) | Required Permission(s) | Link | Description |
---|
Get | WS-ReadRoomPlan | | |
Patch | WS-ModifyRoomPlan | | |
Put | WS-ModifyRoomPlan | | |
Delete | WS-ModifyRoomPlan | | |
Post | WS-ModifyRoomPlan | | |
AreaUsage Structural Properties
Property | Type | Nullable | Mandatory | Read-Only | String length | Min Value | Max Value | Precision | Max Dec Places | Is Only Date | Description |
---|
Description | Edm.String | false | true |
false
| 100 | N/A | N/A | N/A | N/A | | |
ID | Edm.Int32 | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
AreaUsage Navigational Properties
No navigational properties
Verb(s) | Required Permission(s) | Link | Description |
---|
Get | WS-ReadCabinet,WS-ReadServer,WS-ReadUPS,WS-ReadNetwork,WS-ReadPeripheral,WS-ReadStaticSwitch,WS-ReadReceptacle,WS-ReadKVMSwitch,WS-ReadAuxiliary,WS-ReadAirConditioning,WS-ReadChassis,WS-ReadPDU,WS-ReadPowerStrip | integration/api/odata/Assets, integration/api/odata/Assets({key}) | |
Asset Structural Properties
Property | Type | Nullable | Mandatory | Read-Only | String length | Min Value | Max Value | Precision | Max Dec Places | Is Only Date | Description |
---|
ALCAddress | Edm.String | true | false |
false
| 200 | N/A | N/A | N/A | N/A | | |
AssetID | Edm.Int32 | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | Primary key identifying the asset |
AssetName | Edm.String | true | true |
false
| 80 | N/A | N/A | N/A | N/A | | |
AssetNumber | Edm.Int32 | true | false |
true
| N/A | N/A | N/A | N/A | N/A | | Property used to identify a pair of assets representing bi-state assets. |
CabinetAssetID | Edm.Int32 | true | false |
true
| N/A | N/A | N/A | N/A | N/A | | Foreign key identifying the asset of type cabinet, in which the current asset is mounted.. |
CommPort | Edm.String | true | false |
false
| 200 | N/A | N/A | N/A | N/A | | |
CostCenter | Edm.String | true | false |
false
| 255 | N/A | N/A | N/A | N/A | | |
CreationDate | Edm.DateTimeOffset | true | false |
true
| N/A | N/A | N/A | N/A | N/A | IsOnlyDate | Read-only property, representing the date the asset was created. |
CSVAddress | Edm.String | true | false |
false
| 200 | N/A | N/A | N/A | N/A | | |
DamagedRFIDTag | Edm.String | true | false |
false
| 255 | N/A | N/A | N/A | N/A | | |
DecommissionDate | Edm.DateTimeOffset | true | false |
true
| N/A | N/A | N/A | N/A | N/A | | Read-only property, representing the date the asset was decommissioned. |
DeviceInstance | Edm.Int32 | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
GridReference | Edm.String | true | false |
false
| 15 | N/A | N/A | N/A | N/A | | Grid reference information, defined in the room planner |
GridReferenceColumn | Edm.String | true | false |
false
| 10 | N/A | N/A | N/A | N/A | | Grid reference information, defined in the room planner |
GridReferenceLayer | Edm.String | true | false |
false
| 50 | N/A | N/A | N/A | N/A | | String representing the mounting type: null, Cabinet. Cabinet if is mounted directly in a cabinet or its parent is mounted. a cabinet. |
GridReferenceRow | Edm.String | true | false |
false
| 10 | N/A | N/A | N/A | N/A | | Grid reference information, defined in the room planner |
IsStaticSwitchEnabled | Edm.Boolean | false | false |
true
| N/A | N/A | N/A | N/A | N/A | | Used if and only if the plugs have priority set or if the material type from which the asset was created is a static switch, the IsStaticSwitchEnabled is true. |
IsTemplateRelated | Edm.Boolean | false | false |
true
| N/A | N/A | N/A | N/A | N/A | | True if is an asset template |
JCIAddress | Edm.String | true | false |
false
| 200 | N/A | N/A | N/A | N/A | | |
JSONAddress | Edm.String | true | false |
false
| 200 | N/A | N/A | N/A | N/A | | |
LastAssetExplorerScanDate | Edm.DateTimeOffset | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
LastScanned | Edm.String | true | false |
false
| 255 | N/A | N/A | N/A | N/A | | |
LocationGroupID | Edm.Int32 | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | Foreign key identifying the asset location |
LocationGroupOrChildrenID | Edm.Int32 | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
MaterialID | Edm.Int32 | false | true |
false
| N/A | N/A | N/A | N/A | N/A | | The material id from which the asset was created. |
ModbusSlaveID | Edm.Int32 | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
ModiusAddress | Edm.String | true | false |
false
| 200 | N/A | N/A | N/A | N/A | | |
ObjectInstance | Edm.Int32 | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
OPCMachine | Edm.String | true | false |
false
| 200 | N/A | N/A | N/A | N/A | | |
OPCServer | Edm.String | true | false |
false
| 200 | N/A | N/A | N/A | N/A | | |
OperationalDate | Edm.DateTimeOffset | true | false |
false
| N/A | N/A | N/A | N/A | N/A | IsOnlyDate | |
OperationalStatus | Nlyte.Model.OperationalStatusEnum | false | true |
false
| N/A | N/A | N/A | N/A | N/A | | Reflects the current state and/or planned future state. Together with the Record Status, they give the user the exact life-cycle status. |
PacketPowerID | Edm.String | true | false |
false
| 50 | N/A | N/A | N/A | N/A | | |
PollType | Nlyte.Model.PollTypeEnum | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
PONumber | Edm.String | true | false |
false
| 255 | N/A | N/A | N/A | N/A | | |
PowerState | Nlyte.Model.PowerStateEnum | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | Entity is powered or not. |
PRNumber | Edm.String | true | false |
false
| 255 | N/A | N/A | N/A | N/A | | |
PurchaseDate | Edm.DateTimeOffset | true | false |
false
| N/A | N/A | N/A | N/A | N/A | IsOnlyDate | |
PurchasePrice | Edm.Decimal | false | false |
false
| N/A | 0 | 99999999999.99 | 13 | 2 | | |
RecordStatus | Nlyte.Model.RecordStatusEnum | false | true |
false
| N/A | N/A | N/A | N/A | N/A | | Reflects the real status of the asset as is in the data-center Planned or Active/Recycled.. Together with the Record Status, they give the user the exact life-cycle status. |
RFIDTag | Edm.String | true | false |
false
| 255 | N/A | N/A | N/A | N/A | | |
SAPAssetNumber | Edm.String | true | false |
false
| 255 | N/A | N/A | N/A | N/A | | Property used to identify a pair of assets representing bi-state assets. |
SerialNumber | Edm.String | true | false |
false
| 50 | N/A | N/A | N/A | N/A | | |
SubStatusID | Edm.Int32 | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | Sub-status defined in the administration area. |
Tag | Edm.String | true | false |
false
| 255 | N/A | N/A | N/A | N/A | | |
TemplateID | Edm.Int32 | true | false |
true
| N/A | N/A | N/A | N/A | N/A | | The template to which the asset is associated. |
TridiumAddress | Edm.String | true | false |
false
| 200 | N/A | N/A | N/A | N/A | | |
UMountingID | Edm.Int32 | true | false |
true
| N/A | N/A | N/A | N/A | N/A | | The foreign key identifying the entity providing details about the Cabinet U in which an asset is mounted. |
UniqueAssetName | Edm.String | true | false |
true
| 1000 | N/A | N/A | N/A | N/A | | Represents the asset name concatenated with the location ( room, area, floor, building city) |
XMLAddress | Edm.String | true | false |
false
| 200 | N/A | N/A | N/A | N/A | | |
Asset Navigational Properties
Verb(s) | Required Permission(s) | Link | Description |
---|
Get | WS-ReadCabinet,WS-ReadServer,WS-ReadUPS,WS-ReadNetwork,WS-ReadPeripheral,WS-ReadStaticSwitch,WS-ReadReceptacle,WS-ReadKVMSwitch,WS-ReadAuxiliary,WS-ReadAirConditioning,WS-ReadChassis,WS-ReadPDU,WS-ReadPowerStrip,WS-ReadServerHost | integration/api/odata/AssetsAndHosts, integration/api/odata/AssetsAndHosts({key}) | |
AssetAndHost Structural Properties
Property | Type | Nullable | Mandatory | Read-Only | String length | Min Value | Max Value | Precision | Max Dec Places | Is Only Date | Description |
---|
AssetID | Edm.Int32 | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | Primary key identifying the asset |
AssetName | Edm.String | true | true |
false
| N/A | N/A | N/A | N/A | N/A | | |
AssetNumber | Edm.Int32 | true | false |
true
| N/A | N/A | N/A | N/A | N/A | | |
AssetTypeID | Edm.Int32 | false | false |
true
| N/A | N/A | N/A | N/A | N/A | | |
CabinetAssetID | Edm.Int32 | true | false |
true
| N/A | N/A | N/A | N/A | N/A | | Foreign key identifying the asset of type cabinet, in which the current asset is mounted.. |
CabinetAssetName | Edm.String | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
CabinetUNumber | Edm.Int32 | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | The U on which the asset is mounted |
CabinetUsageID | Edm.Int32 | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
ChassisMountedAssetMapID | Edm.Int32 | true | false |
true
| N/A | N/A | N/A | N/A | N/A | | |
CostCenter | Edm.String | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
CreationDate | Edm.DateTimeOffset | true | false |
true
| N/A | N/A | N/A | N/A | N/A | IsOnlyDate | Read-only property, representing the date the asset was created. |
DuplicateLocationGroupName | Edm.String | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | The unique location name, having the name as a concatenation of last hierarchical location names. |
GridReference | Edm.String | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | Grid reference information, defined in the room planner |
GridReferenceColumn | Edm.String | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | Grid reference information, defined in the room planner |
GridReferenceRow | Edm.String | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | Grid reference information, defined in the room planner |
HeatingLimit | Edm.Double | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
HeatThreshold | Edm.Double | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
IsTemplateRelated | Edm.Boolean | false | false |
true
| N/A | N/A | N/A | N/A | N/A | | True if is an asset template |
LocationGroupID | Edm.Int32 | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | Foreign key identifying the asset location |
LocationGroupName | Edm.String | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
LocationGroupOrChildrenID | Edm.Int32 | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
MaterialType | Edm.String | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
MaterialTypeID | Nlyte.Model.MaterialTypeEnum | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
MountingSide | Nlyte.Model.MountingSide | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | Represents the mounting side, property of the asset that holds the mountable asset. |
OperationalDate | Edm.DateTimeOffset | true | false |
false
| N/A | N/A | N/A | N/A | N/A | IsOnlyDate | |
OperationalStatus | Nlyte.Model.OperationalStatusEnum | false | true |
false
| N/A | N/A | N/A | N/A | N/A | | Reflects the current state and/or planned future state. Together with the Record Status, they give the user the exact life-cycle status. |
PONumber | Edm.String | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
PRNumber | Edm.String | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
RecordStatus | Nlyte.Model.RecordStatusEnum | false | true |
false
| N/A | N/A | N/A | N/A | N/A | | Reflects the real status of the entity as is in the data-center Planned or Active/Recycled. Together with the Record Status, they give the user the exact life-cycle status. |
SAPAssetNumber | Edm.String | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | Property used to identify a pair of assets representing bi-state assets. |
SerialNumber | Edm.String | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
SubStatusID | Edm.Int32 | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | Sub-status defined in the administration area. |
AssetAndHost Navigational Properties
Verb(s) | Required Permission(s) | Link | Description |
---|
Get | WS-ReadAssetIPAddressMap,WS-ReadServerHostIPAddressMap | | |
Key(s) |
---|
AssetAndHostIPAddressMapID |
AssetAndHostIPAddressMap Structural Properties
Property | Type | Nullable | Mandatory | Read-Only | String length | Min Value | Max Value | Precision | Max Dec Places | Is Only Date | Description |
---|
AssetAndHostIPAddressMapID | Edm.Int32 | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
AssetID | Edm.Int32 | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | Foreign key for the asset/host for which the IP Address was defined |
AssetTypeID | Edm.Int32 | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | Foreign key for the asset/host for which the IP Address was defined |
IPAddressID | Edm.Int32 | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | Foreign key for the IP Address |
AssetAndHostIPAddressMap Navigational Properties
Verb(s) | Required Permission(s) | Link | Description |
---|
Delete | WS-ModifyAssetAssociationMap | | |
Post | WS-AddAssetAssociationMap | | |
PostWithKey | WS-AddAssetAssociationMap | | |
Get | WS-ReadAssetAssociationMap | | |
Key(s) |
---|
AssetAssociationMapID |
AssetAssociationMap Structural Properties
Property | Type | Nullable | Mandatory | Read-Only | String length | Min Value | Max Value | Precision | Max Dec Places | Is Only Date | Description |
---|
AssetAssociationMapID | Edm.Int32 | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
AssetID | Edm.Int32 | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
AssociatedAssetID | Edm.Int32 | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
AssetAssociationMap Navigational Properties
Verb(s) | Required Permission(s) | Link | Description |
---|
Post | WS-AddNote | | |
Patch | WS-ModifyNote | | |
Delete | WS-ModifyNote | | |
Get | WS-ReadNote | | |
AssetAssociationMapNote Structural Properties
No structural properties
AssetAssociationMapNote Navigational Properties
No navigational properties
Verb(s) | Required Permission(s) | Link | Description |
---|
AssetDisplayLocation Structural Properties
Property | Type | Nullable | Mandatory | Read-Only | String length | Min Value | Max Value | Precision | Max Dec Places | Is Only Date | Description |
---|
DisplayLocationID | Edm.Int32 | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
DisplayLocationName | Edm.String | false | true |
false
| 50 | N/A | N/A | N/A | N/A | | |
AssetDisplayLocation Navigational Properties
No navigational properties
Verb(s) | Required Permission(s) | Link | Description |
---|
Get | WS-ReadFile | | |
Delete | WS-ModifyFile | | |
AssetFile Structural Properties
No structural properties
AssetFile Navigational Properties
No navigational properties
Verb(s) | Required Permission(s) | Link | Description |
---|
Get | WS-ReadAssetIPAddressMap | | |
Delete | WS-ModifyAssetIPAddressMap | | |
Patch | WS-ModifyAssetIPAddressMap | | |
PostWithKey | WS-ModifyAssetIPAddressMap | | |
Post | WS-AddAssetIPAddressMap | | |
Key(s) |
---|
AssetIPAddressMapID |
AssetIPAddressMap Structural Properties
Property | Type | Nullable | Mandatory | Read-Only | String length | Min Value | Max Value | Precision | Max Dec Places | Is Only Date | Description |
---|
AssetID | Edm.Int32 | true | false |
true
| N/A | N/A | N/A | N/A | N/A | | Foreign key for the asset for which the IP Address was defined |
AssetIPAddressMapID | Edm.Int32 | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
IPAddressID | Edm.Int32 | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | Foreign key for the IP Address |
AssetIPAddressMap Navigational Properties
Verb(s) | Required Permission(s) | Link | Description |
---|
AssetMapping Structural Properties
Property | Type | Nullable | Mandatory | Read-Only | String length | Min Value | Max Value | Precision | Max Dec Places | Is Only Date | Description |
---|
AssetID | Edm.Int32 | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
AssetMapID | Edm.Int32 | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
AssetNumber | Edm.Int32 | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
Created | Edm.DateTimeOffset | false | false |
false
| N/A | N/A | N/A | N/A | N/A | IsOnlyDate | |
Discovered | Edm.DateTimeOffset | true | false |
false
| N/A | N/A | N/A | N/A | N/A | IsOnlyDate | |
ExternalID | Edm.String | true | false |
false
| 512 | N/A | N/A | N/A | N/A | | |
ExternalName | Edm.String | true | false |
false
| 70 | N/A | N/A | N/A | N/A | | |
LastUpdated | Edm.DateTimeOffset | false | false |
false
| N/A | N/A | N/A | N/A | N/A | IsOnlyDate | |
ProviderID | Edm.Guid | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
URL | Edm.String | true | false |
false
| 2048 | N/A | N/A | N/A | N/A | | |
AssetMapping Navigational Properties
Verb(s) | Required Permission(s) | Link | Description |
---|
Get | WS-ReadAssetMounting | | |
AssetMounting Structural Properties
Property | Type | Nullable | Mandatory | Read-Only | String length | Min Value | Max Value | Precision | Max Dec Places | Is Only Date | Description |
---|
AssetID | Edm.Int32 | false | false |
true
| N/A | N/A | N/A | N/A | N/A | | AssetID of the asset that holds the mountable asset. |
AssetName | Edm.String | true | false |
true
| N/A | N/A | N/A | N/A | N/A | | AssetName of the asset that holds the mountable asset. |
AssetNumber | Edm.Int32 | false | false |
true
| N/A | N/A | N/A | N/A | N/A | | AssetNumber of the asset that holds the mountable asset. |
LocationGroupID | Edm.Int32 | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
MountedAssetID | Edm.Int32 | true | false |
true
| N/A | N/A | N/A | N/A | N/A | | Represents the AssetID of the asset that is mounted. |
MountingSide | Nlyte.Model.MountingSide | false | |
false
| | | | | | | |
RecordStatus | Nlyte.Model.RecordStatusEnum | false | |
false
| | | | | | | |
AssetMounting Navigational Properties
Verb(s) | Required Permission(s) | Link | Description |
---|
Post | WS-AddNote | | |
Patch | WS-ModifyNote | | |
Delete | WS-ModifyNote | | |
Get | WS-ReadNote | | |
AssetNote Structural Properties
No structural properties
AssetNote Navigational Properties
No navigational properties
Verb(s) | Required Permission(s) | Link | Description |
---|
Get | WS-ReadAssetRealtimeData | integration/api/odata/AssetRealTimeData, integration/api/odata/AssetRealTimeData({key}) | |
Key(s) |
---|
AssetRealtimeDataID |
AssetRealTimeData Structural Properties
Property | Type | Nullable | Mandatory | Read-Only | String length | Min Value | Max Value | Precision | Max Dec Places | Is Only Date | Description |
---|
AssetID | Edm.Int32 | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
AssetRealtimeDataID | Edm.Int32 | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
LastUpdated | Edm.DateTimeOffset | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
LocationGroupID | Edm.Int32 | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
ProviderID | Edm.Int32 | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
RealtimeLoad | Edm.Decimal | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
RealtimeLoadAverage | Edm.Decimal | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
RealtimeLoadMax | Edm.Decimal | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
RealtimeLoadMin | Edm.Decimal | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
RealtimePower | Edm.Decimal | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
RealtimePowerAverage | Edm.Decimal | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
RealtimePowerMax | Edm.Decimal | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
RealtimePowerMin | Edm.Decimal | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
RealtimeTotalEnergy | Edm.Decimal | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
RealtimeVoltage | Edm.Decimal | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
RealtimeVoltageAverage | Edm.Decimal | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
RealtimeVoltageMax | Edm.Decimal | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
RealtimeVoltageMin | Edm.Decimal | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
AssetRealTimeData Navigational Properties
No navigational properties
Verb(s) | Required Permission(s) | Link | Description |
---|
Get | WS-ReadAssetRealtimePhaseData | integration/api/odata/AssetRealTimePhaseData, integration/api/odata/AssetRealTimePhaseData({key}) | |
Key(s) |
---|
AssetRealtimePhaseDataID |
AssetRealTimePhaseData Structural Properties
Property | Type | Nullable | Mandatory | Read-Only | String length | Min Value | Max Value | Precision | Max Dec Places | Is Only Date | Description |
---|
AssetID | Edm.Int32 | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
AssetRealtimePhaseDataID | Edm.Int32 | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
LastUpdated | Edm.DateTimeOffset | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
LocationGroupID | Edm.Int32 | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
Phase1RealtimeLoad | Edm.Decimal | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
Phase1RealtimeLoadAverage | Edm.Decimal | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
Phase1RealtimeLoadMax | Edm.Decimal | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
Phase1RealtimeLoadMin | Edm.Decimal | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
Phase1RealtimePower | Edm.Decimal | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
Phase1RealtimePowerAverage | Edm.Decimal | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
Phase1RealtimePowerMax | Edm.Decimal | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
Phase1RealtimePowerMin | Edm.Decimal | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
Phase1RealtimeVoltage | Edm.Decimal | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
Phase1RealtimeVoltageAverage | Edm.Decimal | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
Phase1RealtimeVoltageMax | Edm.Decimal | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
Phase1RealtimeVoltageMin | Edm.Decimal | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
Phase2RealtimeLoad | Edm.Decimal | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
Phase2RealtimeLoadAverage | Edm.Decimal | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
Phase2RealtimeLoadMax | Edm.Decimal | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
Phase2RealtimeLoadMin | Edm.Decimal | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
Phase2RealtimePower | Edm.Decimal | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
Phase2RealtimePowerAverage | Edm.Decimal | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
Phase2RealtimePowerMax | Edm.Decimal | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
Phase2RealtimePowerMin | Edm.Decimal | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
Phase2RealtimeVoltage | Edm.Decimal | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
Phase2RealtimeVoltageAverage | Edm.Decimal | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
Phase2RealtimeVoltageMax | Edm.Decimal | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
Phase2RealtimeVoltageMin | Edm.Decimal | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
Phase3RealtimeLoad | Edm.Decimal | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
Phase3RealtimeLoadAverage | Edm.Decimal | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
Phase3RealtimeLoadMax | Edm.Decimal | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
Phase3RealtimeLoadMin | Edm.Decimal | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
Phase3RealtimePower | Edm.Decimal | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
Phase3RealtimePowerAverage | Edm.Decimal | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
Phase3RealtimePowerMax | Edm.Decimal | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
Phase3RealtimePowerMin | Edm.Decimal | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
Phase3RealtimeVoltage | Edm.Decimal | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
Phase3RealtimeVoltageAverage | Edm.Decimal | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
Phase3RealtimeVoltageMax | Edm.Decimal | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
Phase3RealtimeVoltageMin | Edm.Decimal | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
ProviderID | Edm.Int32 | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
AssetRealTimePhaseData Navigational Properties
No navigational properties
Verb(s) | Required Permission(s) | Link | Description |
---|
AssetSummaryDC Structural Properties
Property | Type | Nullable | Mandatory | Read-Only | String length | Min Value | Max Value | Precision | Max Dec Places | Is Only Date | Description |
---|
AssetID | Edm.Int32 | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
AssetName | Edm.String | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
AssetNumber | Edm.Int32 | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
CabinetAssetID | Edm.Int32 | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | Key identifying the asset of type cabinet, in which the current asset is mounted.. |
CabinetAssetName | Edm.String | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
DuplicateLocationGroupName | Edm.String | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | The unique location name, having the name as a concatenation of last hierarchical location names. |
LocationGroupID | Edm.Int32 | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | Foreign key identifying the asset location |
MaterialID | Edm.Int32 | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | The key that identifies the material from which the asset was created. |
MaterialName | Edm.String | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
MaterialSubTypeID | Edm.Int32 | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
MaterialTypeID | Edm.Int32 | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
TypeName | Edm.String | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
AssetSummaryDC Navigational Properties
No navigational properties
Verb(s) | Required Permission(s) | Link | Description |
---|
Post | WS-AddAssetTemplate | integration/api/odata/AssetTemplates | |
Get | WS-ReadAssetTemplate | integration/api/odata/AssetTemplates, integration/api/odata/AssetTemplates({key}) | |
Patch | WS-ModifyAssetTemplate | integration/api/odata/AssetTemplates({key}) | |
AssetTemplate Structural Properties
Property | Type | Nullable | Mandatory | Read-Only | String length | Min Value | Max Value | Precision | Max Dec Places | Is Only Date | Description |
---|
AssetIds | Collection(Edm.Int32) | false | true |
true
| N/A | N/A | N/A | N/A | N/A | | A collection of asset IDs included in the template |
CreationDate | Edm.DateTimeOffset | false | false |
true
| N/A | N/A | N/A | N/A | N/A | IsOnlyDate | |
Description | Edm.String | true | false |
false
| 800 | N/A | N/A | N/A | N/A | | |
Id | Edm.Int32 | false | false |
true
| N/A | N/A | N/A | N/A | N/A | | |
IncludePeripherals | Edm.Boolean | true | true |
true
| N/A | N/A | N/A | N/A | N/A | | |
LastUsedDate | Edm.DateTimeOffset | true | false |
true
| N/A | N/A | N/A | N/A | N/A | IsOnlyDate | |
Name | Edm.String | true | true |
false
| 40 | N/A | N/A | N/A | N/A | | |
PurchasePrice | Edm.Decimal | true | false |
false
| N/A | 0 | 99999999999.99 | 13 | 2 | | |
TemplateStatusId | Nlyte.Model.AssetTemplateStatus | false | false |
true
| N/A | N/A | N/A | N/A | N/A | | |
TemplateTypeId | Nlyte.Model.AssetTemplateType | false | true |
true
| N/A | N/A | N/A | N/A | N/A | | Can be for a single asset or floor standing assets |
TotalMPAF | Edm.Decimal | false | false |
true
| N/A | N/A | N/A | N/A | N/A | | |
TotalWeight | Edm.Double | false | false |
true
| N/A | N/A | N/A | N/A | N/A | | |
UsedCount | Edm.Int32 | false | false |
true
| N/A | N/A | N/A | N/A | N/A | | |
AssetTemplate Navigational Properties
Verb(s) | Required Permission(s) | Link | Description |
---|
Post | WS-BeginInstantiateTemplate | integration/api/odata/AssetTemplateInstances | |
AssetTemplateInstance Structural Properties
Property | Type | Nullable | Mandatory | Read-Only | String length | Min Value | Max Value | Precision | Max Dec Places | Is Only Date | Description |
---|
AssetIds | Collection(Edm.Int32) | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | A collection of asset IDs included in the for creating copies. |
CreateCopy | Edm.Boolean | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | Creates a copy of the assets in the templates instead of creating new instances. |
Id | Edm.Int32 | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
InstanceCount | Edm.Int32 | false | true |
false
| N/A | N/A | N/A | N/A | N/A | | |
LocationGroupId | Edm.Int32 | true | true |
false
| N/A | N/A | N/A | N/A | N/A | | Foreign key identifying the asset location |
OperationalStatus | Nlyte.Model.OperationalStatusEnum | false | true |
false
| N/A | N/A | N/A | N/A | N/A | | Reflects the current state and/or planned future state of the asset assigned to a template. Together with the Record Status, they give the user the exact life-cycle status. |
RecordStatus | Nlyte.Model.RecordStatusEnum | false | true |
false
| N/A | N/A | N/A | N/A | N/A | | Reflects the real status of the asset assigned to a template as is in the data-center Planned or Active/Recycled. Together with the Record Status, they give the user the exact life-cycle status. |
TemplateId | Edm.Int32 | false | true |
false
| N/A | N/A | N/A | N/A | N/A | | The associated template |
AssetTemplateInstance Navigational Properties
Verb(s) | Required Permission(s) | Link | Description |
---|
Get | WS-ReadAssetTemplate | integration/api/odata/AssetTemplateJobs, integration/api/odata/AssetTemplateJobs({key}) | |
AssetTemplateJob Structural Properties
Property | Type | Nullable | Mandatory | Read-Only | String length | Min Value | Max Value | Precision | Max Dec Places | Is Only Date | Description |
---|
EndDate | Edm.DateTimeOffset | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
Id | Edm.Int32 | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
JobStatusID | Nlyte.Model.AssetTemplateJobStatus | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | Together with the Progress property is showing the completion status. |
JobTypeID | Nlyte.Model.AssetTemplateJobType | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | Shows the template job purpose |
Progress | Edm.Decimal | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | Property that shows the completion percentage for template creation/instantiation |
StartDate | Edm.DateTimeOffset | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
TemplateID | Edm.Int32 | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | The associated template The template for which the job is active. |
AssetTemplateJob Navigational Properties
Verb(s) | Required Permission(s) | Link | Description |
---|
Get | WS-ReadAssetTemplate | | |
AssetTemplateJobItem Structural Properties
Property | Type | Nullable | Mandatory | Read-Only | String length | Min Value | Max Value | Precision | Max Dec Places | Is Only Date | Description |
---|
JobID | Edm.Int32 | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
NewAssetID | Edm.Int32 | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
AssetTemplateJobItem Navigational Properties
Verb(s) | Required Permission(s) | Link | Description |
---|
Get | WS-AssetUpload | integration/api/odata/AssetUploaderJobs, integration/api/odata/AssetUploaderJobs({key}) | |
Post | WS-AssetUpload | integration/api/odata/AssetUploaderJobs | |
Delete | WS-AssetUpload | integration/api/odata/AssetUploaderJobs({key}) | |
AssetUploaderJob Structural Properties
Property | Type | Nullable | Mandatory | Read-Only | String length | Min Value | Max Value | Precision | Max Dec Places | Is Only Date | Description |
---|
EndDate | Edm.DateTimeOffset | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
ErrorMessage | Edm.String | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
Id | Edm.Int32 | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
JobCancelUserId | Edm.Int32 | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
JobRequestUrl | Edm.String | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | Shows the url address of the endpoint used for uploading the asset auto loader file |
JobRequestUserId | Edm.Int32 | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
JobStatusID | Nlyte.Model.AssetUploaderJobStatus | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | Together with the Progress property is showing the completion status. |
Progress | Edm.Decimal | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | Property that shows the completion percentage for number of rows processed from the uploaded asset auto load file |
StartDate | Edm.DateTimeOffset | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
UploadDate | Edm.DateTimeOffset | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
UploadedFileId | Edm.Int32 | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
UploadedFileName | Edm.String | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
AssetUploaderJob Navigational Properties
Verb(s) | Required Permission(s) | Link | Description |
---|
Post | WS-AssetUpload | | |
Delete | WS-AssetUpload | | |
Get | WS-AssetUpload | | |
AssetUploaderJobItem Structural Properties
Property | Type | Nullable | Mandatory | Read-Only | String length | Min Value | Max Value | Precision | Max Dec Places | Is Only Date | Description |
---|
FileRowNr | Edm.Int64 | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
Id | Edm.Int64 | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
JobID | Edm.Int32 | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
NewAssetID | Edm.Int32 | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
ResponseMessages | Edm.String | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
ResponseStatusCode | Edm.Int32 | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
AssetUploaderJobItem Navigational Properties
Verb(s) | Required Permission(s) | Link | Description |
---|
Assignee Structural Properties
Property | Type | Nullable | Mandatory | Read-Only | String length | Min Value | Max Value | Precision | Max Dec Places | Is Only Date | Description |
---|
AssigneeGroupsOfResourceID | Edm.Int32 | false | false |
true
| N/A | N/A | N/A | N/A | N/A | | |
AssigneeType | Nlyte.Model.AssigneeType | false | true |
false
| N/A | N/A | N/A | N/A | N/A | | |
BusinessGroupID | Edm.Int32 | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
GroupName | Edm.String | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
ID | Edm.Int32 | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
Name | Edm.String | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
ResourceID | Edm.Int32 | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
ResourceName | Edm.String | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
SupportGroupID | Edm.Int32 | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
Assignee Navigational Properties
Verb(s) | Required Permission(s) | Link | Description |
---|
Get | WS-ReadAuditLog | | |
AuditLogInfo Structural Properties
Property | Type | Nullable | Mandatory | Read-Only | String length | Min Value | Max Value | Precision | Max Dec Places | Is Only Date | Description |
---|
EntityID | Edm.Int32 | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
RecordModified | Edm.DateTimeOffset | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
RecordModifiedBy | Edm.String | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
AuditLogInfo Navigational Properties
No navigational properties
Auxiliary Entity
: Asset
- Asset created from a material of type auxiliary, entity inheriting the Nlyte.Model.Asset entity
Verb(s) | Required Permission(s) | Link | Description |
---|
Get | WS-ReadAuxiliary | integration/api/odata/Auxiliaries, integration/api/odata/Auxiliaries({key}) | |
Patch | WS-ModifyAuxiliary | integration/api/odata/Auxiliaries({key}) | |
PostWithKey | WS-ModifyAuxiliary | integration/api/odata/Auxiliaries({key}) | |
Delete | WS-ModifyAuxiliary | integration/api/odata/Auxiliaries({key}) | |
Post | WS-AddAuxiliary | integration/api/odata/Auxiliaries | |
Auxiliary Structural Properties
Property | Type | Nullable | Mandatory | Read-Only | String length | Min Value | Max Value | Precision | Max Dec Places | Is Only Date | Description |
---|
AuditDate | Edm.DateTimeOffset | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
AuditStatusCorrect | Edm.Boolean | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
CurrentPowerFactor | Edm.Decimal | true | false |
true
| N/A | N/A | N/A | N/A | N/A | | Read-only property representing the percentage of power drawn by a PDD asset that is available to its consumers |
IsMasterRedundancyDevice | Edm.Boolean | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | Value inserted by the user |
LastAuditorAccountID | Edm.Int32 | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
LastTestDate | Edm.DateTimeOffset | true | false |
false
| N/A | N/A | N/A | N/A | N/A | IsOnlyDate | |
OutputCount | Edm.Int32 | false | false |
true
| N/A | N/A | N/A | N/A | N/A | | |
PowerFactorOverride | Edm.Decimal | true | false |
false
| N/A | 0 | 1 | 3 | 2 | | Value provided by the user, overriding the CurrentPowerFactor value |
RealtimePowerFactor | Edm.Decimal | true | false |
true
| N/A | N/A | N/A | N/A | N/A | | Read-only value. |
Auxiliary Navigational Properties
Verb(s) | Required Permission(s) | Link | Description |
---|
Get | WS-ReadAuxiliaryMaterial | integration/api/odata/AuxiliaryMaterials, integration/api/odata/AuxiliaryMaterials({key}) | |
Post | WS-AddAuxiliaryMaterial | integration/api/odata/AuxiliaryMaterials | |
PostWithKey | WS-ModifyAuxiliaryMaterial | | |
Patch | WS-ModifyAuxiliaryMaterial | integration/api/odata/AuxiliaryMaterials({key}) | |
Delete | WS-ModifyAuxiliaryMaterial | integration/api/odata/AuxiliaryMaterials({key}) | |
AuxiliaryMaterial Structural Properties
Property | Type | Nullable | Mandatory | Read-Only | String length | Min Value | Max Value | Precision | Max Dec Places | Is Only Date | Description |
---|
CalculatedMaxKW | Edm.Decimal | true | false |
true
| N/A | N/A | N/A | N/A | N/A | | Read-only value, calculated based on the MaxKW and MaxKVA |
DistributorPowerFactor | Edm.Decimal | false | false |
true
| N/A | N/A | N/A | N/A | N/A | | |
MaterialCategoryID | Edm.Int32 | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
MaterialSubtypeID | Edm.Int32 | true | false |
true
| N/A | N/A | N/A | N/A | N/A | | Each material type has its own sub-types, to properly identify the material and the asset created from the material. |
MaxA | Edm.Decimal | true | false |
false
| N/A | 0 | 99999.999 | 8 | 3 | | |
MaxKVA | Edm.Decimal | true | false |
false
| N/A | 0 | 99999999.9999 | 12 | 4 | | |
MaxKW | Edm.Decimal | true | false |
false
| N/A | 0 | 99999999.9999 | 12 | 4 | | |
MaxV | Edm.Decimal | true | false |
false
| N/A | 0 | 99999.999 | 8 | 3 | | |
PowerTypeID | Nlyte.Model.PowerTypeEnum | true | false |
true
| N/A | N/A | N/A | N/A | N/A | | Power type: phased or direct current |
UHeight | Edm.Int64 | false | false |
true
| N/A | N/A | N/A | N/A | N/A | | |
WorkableFootPrintFront | Edm.Double | false | false |
false
| N/A | 0 | 999999999999.9999 | 16 | 4 | | |
WorkableFootPrintHeight | Edm.Double | false | false |
false
| N/A | 0 | 999999999999.9999 | 16 | 4 | | |
WorkableFootPrintRear | Edm.Double | false | false |
false
| N/A | 0 | 999999999999.9999 | 16 | 4 | | |
AuxiliaryMaterial Navigational Properties
No navigational properties
Verb(s) | Required Permission(s) | Link | Description |
---|
Get | WS-ReadServerMaterial | integration/api/odata/BladeServerMaterials, integration/api/odata/BladeServerMaterials({key}) | |
Post | WS-AddServerMaterial | integration/api/odata/BladeServerMaterials | |
PostWithKey | WS-ModifyServerMaterial | | |
Patch | WS-ModifyServerMaterial | integration/api/odata/BladeServerMaterials({key}) | |
Delete | WS-ModifyServerMaterial | integration/api/odata/BladeServerMaterials({key}) | |
BladeServerMaterial Structural Properties
Property | Type | Nullable | Mandatory | Read-Only | String length | Min Value | Max Value | Precision | Max Dec Places | Is Only Date | Description |
---|
MaterialCategoryID | Edm.Int32 | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
PublishedPowerConsumption | Edm.Decimal | false | false |
false
| N/A | 0.001 | 999 | 6 | 3 | | |
BladeServerMaterial Navigational Properties
No navigational properties
Verb(s) | Required Permission(s) | Link | Description |
---|
Get | WS-ReadPDUMaterial | integration/api/odata/BoardPDUMaterials, integration/api/odata/BoardPDUMaterials({key}) | |
Post | WS-AddPDUMaterial | integration/api/odata/BoardPDUMaterials | |
PostWithKey | WS-ModifyPDUMaterial | | |
Patch | WS-ModifyPDUMaterial | integration/api/odata/BoardPDUMaterials({key}) | |
Delete | WS-ModifyPDUMaterial | integration/api/odata/BoardPDUMaterials({key}) | |
BoardPDUMaterial Structural Properties
No structural properties
BoardPDUMaterial Navigational Properties
No navigational properties
Verb(s) | Required Permission(s) | Link | Description |
---|
Get | WS-ReadPDUBreaker | integration/api/odata/Breakers, integration/api/odata/Breakers({key}) | |
Delete | WS-ModifyPDUBreaker | integration/api/odata/Breakers({key}) | |
Patch | WS-ModifyPDUBreaker | integration/api/odata/Breakers({key}) | |
PostWithKey | WS-ModifyPDUBreaker | | |
Post | WS-AddPDUBreaker | | |
Breaker Structural Properties
Property | Type | Nullable | Mandatory | Read-Only | String length | Min Value | Max Value | Precision | Max Dec Places | Is Only Date | Description |
---|
Amperage | Edm.Int32 | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
ApprovedBy | Edm.String | true | false |
false
| 50 | N/A | N/A | N/A | N/A | | |
ApprovedDate | Edm.DateTimeOffset | true | false |
false
| N/A | N/A | N/A | N/A | N/A | IsOnlyDate | |
BreakerID | Edm.Int32 | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
BreakerNumber | Edm.Int32 | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
BreakerPanelID | Edm.Int32 | true | false |
true
| N/A | N/A | N/A | N/A | N/A | | |
Curve | Edm.String | true | false |
false
| 3 | N/A | N/A | N/A | N/A | | |
GroundFaultDevice | Edm.Boolean | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
GroundFaultDeviceInitialTestDate | Edm.DateTimeOffset | true | false |
false
| N/A | N/A | N/A | N/A | N/A | IsOnlyDate | |
GroundFaultDeviceLastTestDate | Edm.DateTimeOffset | true | false |
false
| N/A | N/A | N/A | N/A | N/A | IsOnlyDate | |
GroundFaultDeviceTestResult | Edm.Decimal | true | false |
false
| N/A | 0 | 9999.9999 | 8 | 4 | | |
InstallationDate | Edm.DateTimeOffset | true | false |
false
| N/A | N/A | N/A | N/A | N/A | IsOnlyDate | |
IsEmpty | Edm.Boolean | false | false |
true
| N/A | N/A | N/A | N/A | N/A | | |
LocationGroupID | Edm.Int32 | false | false |
true
| N/A | N/A | N/A | N/A | N/A | | |
ManufacturerID | Edm.Int32 | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
Model | Edm.String | true | false |
false
| 30 | N/A | N/A | N/A | N/A | | |
Name | Edm.String | true | false |
false
| 140 | N/A | N/A | N/A | N/A | | |
PhaseColour | Edm.String | true | false |
false
| 255 | N/A | N/A | N/A | N/A | | |
PhaseColourIndex | Edm.Int32 | true | false |
true
| N/A | N/A | N/A | N/A | N/A | | |
PhaseMasterBreakerID | Edm.Int32 | true | false |
true
| N/A | N/A | N/A | N/A | N/A | | |
PhaseMasterPosition | Edm.Int32 | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
PlannedServiceOffDescription | Edm.String | true | false |
false
| 250 | N/A | N/A | N/A | N/A | | |
PlannedServiceOffEndDate | Edm.DateTimeOffset | true | false |
false
| N/A | N/A | N/A | N/A | N/A | IsOnlyDate | |
PlannedServiceOffStartDate | Edm.DateTimeOffset | true | false |
false
| N/A | N/A | N/A | N/A | N/A | IsOnlyDate | |
Position | Edm.Int32 | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
PowerDate | Edm.DateTimeOffset | true | false |
false
| N/A | N/A | N/A | N/A | N/A | IsOnlyDate | |
PowerTypeID | Nlyte.Model.PowerTypeEnum | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | Power type: phased or direct current |
ReceptacleMaterialID | Edm.Int32 | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | The key that identifies the material from which the parent asset was created. |
Type | Edm.String | true | false |
false
| 255 | N/A | N/A | N/A | N/A | | |
Breaker Navigational Properties
Verb(s) | Required Permission(s) | Link | Description |
---|
Get | WS-ReadPDUPanel | integration/api/odata/BreakerPanels, integration/api/odata/BreakerPanels({key}) | |
Delete | WS-ModifyPDUPanel | integration/api/odata/BreakerPanels({key}) | |
Patch | WS-ModifyPDUPanel | integration/api/odata/BreakerPanels({key}) | |
PostWithKey | WS-ModifyPDUPanel | integration/api/odata/BreakerPanels({key}) | |
Post | WS-AddPDUPanel | integration/api/odata/BreakerPanels | |
BreakerPanel Structural Properties
Property | Type | Nullable | Mandatory | Read-Only | String length | Min Value | Max Value | Precision | Max Dec Places | Is Only Date | Description |
---|
AssetID | Edm.Int32 | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
BreakerPanelID | Edm.Int32 | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
LocationGroupID | Edm.Int32 | false | false |
true
| N/A | N/A | N/A | N/A | N/A | | |
NumberOfBreakers | Edm.Int32 | true | true |
false
| N/A | N/A | N/A | N/A | N/A | | |
PanelIPAddress | Edm.String | true | false |
false
| 50 | N/A | N/A | N/A | N/A | | |
PanelModbusSlaveID | Edm.String | true | false |
false
| 255 | N/A | N/A | N/A | N/A | | |
PanelName | Edm.String | true | true |
false
| 50 | N/A | N/A | N/A | N/A | | |
PanelNEOProfile | Edm.String | true | false |
false
| 200 | N/A | N/A | N/A | N/A | | |
PanelNumber | Edm.Int32 | false | true |
false
| N/A | N/A | N/A | N/A | N/A | | |
Phases | Nlyte.Model.PowerTypeEnum | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
PowerFactor | Edm.Decimal | true | false |
false
| N/A | 0 | 1 | 4 | 3 | | |
RatedAmps | Edm.Int32 | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
StartingNumber | Edm.Int32 | false | true |
false
| N/A | N/A | N/A | N/A | N/A | | |
StartingPosition | Edm.Int32 | false | true |
false
| N/A | N/A | N/A | N/A | N/A | | |
VoltsL2L | Nlyte.Model.VoltsL2LEnum | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
BreakerPanel Navigational Properties
Verb(s) | Required Permission(s) | Link | Description |
---|
Get | WS-ReadPDUMaterial | integration/api/odata/BusBarPDUMaterials, integration/api/odata/BusBarPDUMaterials({key}) | |
Post | WS-AddPDUMaterial | integration/api/odata/BusBarPDUMaterials | |
PostWithKey | WS-ModifyPDUMaterial | | |
Patch | WS-ModifyPDUMaterial | integration/api/odata/BusBarPDUMaterials({key}) | |
Delete | WS-ModifyPDUMaterial | integration/api/odata/BusBarPDUMaterials({key}) | |
BusBarPDUMaterial Structural Properties
No structural properties
BusBarPDUMaterial Navigational Properties
No navigational properties
Verb(s) | Required Permission(s) | Link | Description |
---|
Get | WS-ReadBusinessApplication | integration/api/odata/BusinessApplications, integration/api/odata/BusinessApplications({key}) | |
Patch | WS-ModifyBusinessApplication | integration/api/odata/BusinessApplications({key}) | |
Delete | WS-ModifyBusinessApplication | integration/api/odata/BusinessApplications({key}) | |
Post | WS-AddBusinessApplication | integration/api/odata/BusinessApplications | |
PostWithKey | WS-ModifyBusinessApplication | integration/api/odata/BusinessApplications({key}) | |
Key(s) |
---|
BusinessApplicationID |
BusinessApplication Structural Properties
Property | Type | Nullable | Mandatory | Read-Only | String length | Min Value | Max Value | Precision | Max Dec Places | Is Only Date | Description |
---|
ApplicationManagerResourceID | Edm.Int32 | true | false |
true
| N/A | N/A | N/A | N/A | N/A | | The resource id identifying the resource acting as manager for the business application. |
BusinessApplicationID | Edm.Int32 | false | false |
true
| N/A | N/A | N/A | N/A | N/A | | Primary key |
BusinessApplicationLifecycleStatusID | Edm.Int32 | true | true |
false
| N/A | N/A | N/A | N/A | N/A | | Life-cycle status id, property defined in the administration areas |
BusinessApplicationName | Edm.String | false | true |
false
| 255 | N/A | N/A | N/A | N/A | | |
BusinessApplicationNumber | Edm.Int32 | true | false |
true
| N/A | N/A | N/A | N/A | N/A | | |
BusinessApplicationStrategyDate | Edm.DateTimeOffset | true | false |
true
| N/A | N/A | N/A | N/A | N/A | | |
BusinessApplicationStrategyID | Edm.Int32 | true | true |
false
| N/A | N/A | N/A | N/A | N/A | | Strategy defined in the administration areas, for business applications. |
BusinessCriticalityID | Edm.Int32 | true | true |
false
| N/A | N/A | N/A | N/A | N/A | | Criticality id, property defined in the administration areas, for business applications. |
CreationDate | Edm.DateTimeOffset | true | false |
true
| N/A | N/A | N/A | N/A | N/A | IsOnlyDate | |
DataConfidentialityID | Edm.Int32 | true | true |
false
| N/A | N/A | N/A | N/A | N/A | | Confidentiality id, property defined in the administration areas, for business applications. |
DataRecoveryID | Edm.Int32 | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | Data recovery id, property defined in the administration areas, for business applications. |
Description | Edm.String | true | false |
false
| 1000 | N/A | N/A | N/A | N/A | | |
ProductionDate | Edm.DateTimeOffset | true | false |
true
| N/A | N/A | N/A | N/A | N/A | IsOnlyDate | |
RecordStatus | Nlyte.Model.BusinessApplicationRecordStatus | false | false |
true
| N/A | N/A | N/A | N/A | N/A | | Reflects the real status of the entity as is in the data-center Canceled or Active. |
SoftwareID | Edm.Int32 | true | true |
false
| N/A | N/A | N/A | N/A | N/A | | The software Id used as business application parent |
BusinessApplication Navigational Properties
Verb(s) | Required Permission(s) | Link | Description |
---|
Get | WS-ReadBusinessApplicationBusinessGroupMap | | |
Patch | WS-ModifyBusinessApplicationBusinessGroupMap | | |
Delete | WS-ModifyBusinessApplicationBusinessGroupMap | | |
Post | WS-AddBusinessApplicationBusinessGroupMap | | |
PostWithKey | WS-ModifyBusinessApplicationBusinessGroupMap | | |
BusinessApplicationBusinessGroupMap Structural Properties
Property | Type | Nullable | Mandatory | Read-Only | String length | Min Value | Max Value | Precision | Max Dec Places | Is Only Date | Description |
---|
BusinessGroupID | Edm.Int32 | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
BusinessGroupName | Edm.String | true | false |
false
| 255 | N/A | N/A | N/A | N/A | | |
BusinessGroupNumber | Edm.Int32 | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
ColourIndex | Edm.Int32 | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
CultureID | Edm.Int32 | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
Description | Edm.String | true | false |
false
| 255 | N/A | N/A | N/A | N/A | | |
EmailAddress | Edm.String | true | false |
false
| 254 | N/A | N/A | N/A | N/A | | |
ID | Edm.Int32 | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
OwnershipPercentage | Edm.Byte | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
ParentBusinessGroupID | Edm.Int32 | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
RecordStatus | Edm.Int32 | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | Reflects the real status of the entity as is in the data-center Canceled or Active. |
TelephoneNumber | Edm.String | true | false |
false
| 30 | N/A | N/A | N/A | N/A | | |
BusinessApplicationBusinessGroupMap Navigational Properties
Verb(s) | Required Permission(s) | Link | Description |
---|
Key(s) |
---|
BusinessApplicationLifecycleStatusID |
BusinessApplicationLifecycleStatus Structural Properties
Property | Type | Nullable | Mandatory | Read-Only | String length | Min Value | Max Value | Precision | Max Dec Places | Is Only Date | Description |
---|
BusinessApplicationLifecycleStatusID | Edm.Int32 | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
Detail | Edm.String | false | true |
false
| 30 | N/A | N/A | N/A | N/A | | Business Application Lifecycle Status |
BusinessApplicationLifecycleStatus Navigational Properties
No navigational properties
Verb(s) | Required Permission(s) | Link | Description |
---|
BusinessApplicationPickerControl Structural Properties
Property | Type | Nullable | Mandatory | Read-Only | String length | Min Value | Max Value | Precision | Max Dec Places | Is Only Date | Description |
---|
RowSpan | Edm.Int32 | false | true |
false
| N/A | N/A | N/A | N/A | N/A | | |
TotalText | Edm.String | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
BusinessApplicationPickerControl Navigational Properties
No navigational properties
Verb(s) | Required Permission(s) | Link | Description |
---|
BusinessApplicationPickerControlValue Structural Properties
No structural properties
BusinessApplicationPickerControlValue Navigational Properties
No navigational properties
Verb(s) | Required Permission(s) | Link | Description |
---|
Get | WS-ReadBusinessApplication | | |
Patch | WS-ModifyBusinessApplication | | |
Delete | WS-ModifyBusinessApplication | | |
Post | WS-AddBusinessApplication | | |
PostWithKey | WS-ModifyBusinessApplication | | |
BusinessApplicationServerHostMap Structural Properties
Property | Type | Nullable | Mandatory | Read-Only | String length | Min Value | Max Value | Precision | Max Dec Places | Is Only Date | Description |
---|
ApplicationManagerResourceID | Edm.Int32 | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
BASHPID | Edm.Int32 | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
BusinessApplicationID | Edm.Int32 | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
BusinessApplicationLifecycleStatusID | Edm.Int32 | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | Life-cycle status id, property defined in the administration areas |
BusinessApplicationName | Edm.String | true | false |
false
| 255 | N/A | N/A | N/A | N/A | | |
BusinessApplicationNumber | Edm.Int32 | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
BusinessApplicationStrategyDate | Edm.DateTimeOffset | true | false |
false
| N/A | N/A | N/A | N/A | N/A | IsOnlyDate | |
BusinessApplicationStrategyID | Edm.Int32 | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | Strategy defined in the administration areas, for business applications. |
BusinessCriticalityID | Edm.Int32 | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | Criticality id, property defined in the administration areas, for business applications. |
CreationDate | Edm.DateTimeOffset | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
DataConfidentialityID | Edm.Int32 | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | Confidentiality id, property defined in the administration areas, for business applications. |
DataRecoveryID | Edm.Int32 | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | Data recovery id, property defined in the administration areas, for business applications. |
Description | Edm.String | true | false |
false
| 1000 | N/A | N/A | N/A | N/A | | |
OwnershipPercentage | Edm.Int32 | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
ProductionDate | Edm.DateTimeOffset | true | false |
false
| N/A | N/A | N/A | N/A | N/A | IsOnlyDate | |
RecordStatus | Nlyte.Model.BusinessApplicationRecordStatus | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | Reflects the real status of the entity as is in the data-center Canceled or Active. |
ServerHostID | Edm.Int32 | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
SoftwareID | Edm.Int32 | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
BusinessApplicationServerHostMap Navigational Properties
Verb(s) | Required Permission(s) | Link | Description |
---|
Key(s) |
---|
BusinessApplicationStrategyID |
BusinessApplicationStrategy Structural Properties
Property | Type | Nullable | Mandatory | Read-Only | String length | Min Value | Max Value | Precision | Max Dec Places | Is Only Date | Description |
---|
BusinessApplicationStrategyID | Edm.Int32 | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
Detail | Edm.String | false | true |
false
| 30 | N/A | N/A | N/A | N/A | | |
BusinessApplicationStrategy Navigational Properties
No navigational properties
Verb(s) | Required Permission(s) | Link | Description |
---|
Get | WS-ReadBusinessApplicationSupportGroupMap | | |
Patch | WS-ModifyBusinessApplicationSupportGroupMap | | |
Delete | WS-ModifyBusinessApplicationSupportGroupMap | | |
Post | WS-AddBusinessApplicationSupportGroupMap | | |
PostWithKey | WS-ModifyBusinessApplicationSupportGroupMap | | |
BusinessApplicationSupportGroupMap Structural Properties
Property | Type | Nullable | Mandatory | Read-Only | String length | Min Value | Max Value | Precision | Max Dec Places | Is Only Date | Description |
---|
ColourIndex | Edm.Int32 | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
CultureID | Edm.Int32 | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
Description | Edm.String | true | false |
false
| 255 | N/A | N/A | N/A | N/A | | |
EmailAddress | Edm.String | true | false |
false
| 254 | N/A | N/A | N/A | N/A | | |
ID | Edm.Int32 | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
ParentSupportGroupID | Edm.Int32 | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
RecordStatus | Edm.Int32 | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | Reflects the real status of the entity as is in the data-center Canceled or Active. |
SupportGroupID | Edm.Int32 | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
SupportGroupName | Edm.String | true | false |
false
| 255 | N/A | N/A | N/A | N/A | | |
SupportGroupNumber | Edm.Int32 | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
SupportPercentage | Edm.Byte | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
TelephoneNumber | Edm.String | true | false |
false
| 30 | N/A | N/A | N/A | N/A | | |
BusinessApplicationSupportGroupMap Navigational Properties
Verb(s) | Required Permission(s) | Link | Description |
---|
Key(s) |
---|
BusinessCriticalityID |
BusinessCriticality Structural Properties
Property | Type | Nullable | Mandatory | Read-Only | String length | Min Value | Max Value | Precision | Max Dec Places | Is Only Date | Description |
---|
BusinessCriticalityID | Edm.Int32 | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
Detail | Edm.String | false | true |
false
| 30 | N/A | N/A | N/A | N/A | | |
BusinessCriticality Navigational Properties
No navigational properties
Verb(s) | Required Permission(s) | Link | Description |
---|
Get | WS-ReadBusinessGroup | integration/api/odata/BusinessGroups, integration/api/odata/BusinessGroups({key}) | |
Patch | WS-ModifyBusinessGroup | integration/api/odata/BusinessGroups({key}) | |
Delete | WS-ModifyBusinessGroup | integration/api/odata/BusinessGroups({key}) | |
Post | WS-AddBusinessGroup | integration/api/odata/BusinessGroups | |
PostWithKey | WS-ModifyBusinessGroup | integration/api/odata/BusinessGroups({key}) | |
BusinessGroup Structural Properties
Property | Type | Nullable | Mandatory | Read-Only | String length | Min Value | Max Value | Precision | Max Dec Places | Is Only Date | Description |
---|
AssigneeID | Edm.Int32 | false | false |
true
| N/A | N/A | N/A | N/A | N/A | | |
BusinessGroupID | Edm.Int32 | true | false |
true
| N/A | N/A | N/A | N/A | N/A | | |
BusinessGroupName | Edm.String | false | true |
false
| 255 | N/A | N/A | N/A | N/A | | |
BusinessGroupNumber | Edm.Int32 | true | false |
true
| N/A | N/A | N/A | N/A | N/A | | |
Description | Edm.String | true | false |
false
| 255 | N/A | N/A | N/A | N/A | | |
EmailAddress | Edm.String | true | false |
false
| 254 | N/A | N/A | N/A | N/A | | |
HasChildren | Edm.Boolean | false | false |
true
| N/A | N/A | N/A | N/A | N/A | | |
ParentBusinessGroupID | Edm.Int32 | false | true |
true
| N/A | N/A | N/A | N/A | N/A | | |
RecordStatus | Nlyte.Model.OrganisationGroupRecordStatus | false | false |
true
| N/A | N/A | N/A | N/A | N/A | | Reflects the real status of the group as is in the data-center Canceled or Active. |
TelephoneNumber | Edm.String | true | false |
false
| 30 | N/A | N/A | N/A | N/A | | |
BusinessGroup Navigational Properties
Verb(s) | Required Permission(s) | Link | Description |
---|
Get | WS-ReadBusinessGroupAssetMap | | |
Patch | WS-ModifyBusinessGroupAssetMap | | |
Delete | WS-ModifyBusinessGroupAssetMap | | |
Post | WS-AddBusinessGroupAssetMap | | |
PostWithKey | WS-ModifyBusinessGroupAssetMap | | |
BusinessGroupAssetMap Structural Properties
Property | Type | Nullable | Mandatory | Read-Only | String length | Min Value | Max Value | Precision | Max Dec Places | Is Only Date | Description |
---|
BusinessGroupID | Edm.Int32 | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
BusinessGroupName | Edm.String | true | false |
false
| 255 | N/A | N/A | N/A | N/A | | |
BusinessGroupNumber | Edm.Int32 | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
ColourIndex | Edm.Int32 | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
CultureID | Edm.Int32 | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
Description | Edm.String | true | false |
false
| 255 | N/A | N/A | N/A | N/A | | |
EmailAddress | Edm.String | true | false |
false
| 254 | N/A | N/A | N/A | N/A | | |
ID | Edm.Int32 | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
OwnershipPercentage | Edm.Byte | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
ParentBusinessGroupID | Edm.Int32 | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
RecordStatus | Edm.Int32 | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
TelephoneNumber | Edm.String | true | false |
false
| 30 | N/A | N/A | N/A | N/A | | |
BusinessGroupAssetMap Navigational Properties
Verb(s) | Required Permission(s) | Link | Description |
---|
Post | WS-AddNote | | |
Patch | WS-ModifyNote | | |
Delete | WS-ModifyNote | | |
Get | WS-ReadNote | | |
BusinessGroupNote Structural Properties
No structural properties
BusinessGroupNote Navigational Properties
No navigational properties
Verb(s) | Required Permission(s) | Link | Description |
---|
Get | WS-ReadBusinessGroupResourceMap | | |
Patch | WS-ModifyBusinessGroupResourceMap | | |
Delete | WS-ModifyBusinessGroupResourceMap | | |
Post | WS-AddBusinessGroupResourceMap | | |
Key(s) |
---|
BusinessGroupResourceMapID |
BusinessGroupResourceMap Structural Properties
Property | Type | Nullable | Mandatory | Read-Only | String length | Min Value | Max Value | Precision | Max Dec Places | Is Only Date | Description |
---|
BusinessGroupID | Edm.Int32 | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
BusinessGroupResourceMapID | Edm.Int32 | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
ClientUserGUID | Edm.String | true | false |
true
| 100 | N/A | N/A | N/A | N/A | | |
Company | Edm.String | true | false |
true
| 50 | N/A | N/A | N/A | N/A | | |
CompanyPhoneNumber | Edm.String | true | false |
true
| 50 | N/A | N/A | N/A | N/A | | |
CultureID | Edm.Int32 | true | false |
true
| N/A | N/A | N/A | N/A | N/A | | |
Department | Edm.String | true | false |
true
| 50 | N/A | N/A | N/A | N/A | | |
DepartmentPhoneNumber | Edm.String | true | false |
true
| 50 | N/A | N/A | N/A | N/A | | |
Email | Edm.String | true | false |
true
| 254 | N/A | N/A | N/A | N/A | | |
Forename | Edm.String | true | false |
true
| 50 | N/A | N/A | N/A | N/A | | |
ManagerResourceID | Edm.Int32 | true | false |
true
| N/A | N/A | N/A | N/A | N/A | | |
MeasurementSystemID | Edm.Int32 | true | false |
true
| N/A | N/A | N/A | N/A | N/A | | |
Middlename | Edm.String | true | false |
true
| 50 | N/A | N/A | N/A | N/A | | |
MobileNumber | Edm.String | true | false |
true
| 50 | N/A | N/A | N/A | N/A | | |
PhoneNumber | Edm.String | true | false |
true
| 50 | N/A | N/A | N/A | N/A | | |
Priority | Edm.Int32 | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
ResourceID | Edm.Int32 | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
RFIDCardID | Edm.String | true | false |
true
| 50 | N/A | N/A | N/A | N/A | | |
Surname | Edm.String | true | false |
true
| 50 | N/A | N/A | N/A | N/A | | |
TimeZone | Edm.Double | true | false |
true
| N/A | N/A | N/A | N/A | N/A | | |
Title | Edm.String | true | false |
true
| 10 | N/A | N/A | N/A | N/A | | |
BusinessGroupResourceMap Navigational Properties
Cabinet Entity
: Asset
- Asset created from a material of type cabinet, entity inheriting the Nlyte.Model.Asset entity
Verb(s) | Required Permission(s) | Link | Description |
---|
Get | WS-ReadCabinet | integration/api/odata/Cabinets, integration/api/odata/Cabinets({key}) | |
Post | WS-AddCabinet | integration/api/odata/Cabinets | |
Patch | WS-ModifyCabinet | integration/api/odata/Cabinets({key}) | |
PostWithKey | WS-ModifyCabinet | integration/api/odata/Cabinets({key}) | |
Delete | WS-ModifyCabinet | integration/api/odata/Cabinets({key}) | |
Cabinet Structural Properties
Property | Type | Nullable | Mandatory | Read-Only | String length | Min Value | Max Value | Precision | Max Dec Places | Is Only Date | Description |
---|
AuditDate | Edm.DateTimeOffset | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
AuditStatusCorrect | Edm.Boolean | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
CabinetUOrder | Nlyte.Model.CabinetUOrderEnum | false | |
false
| | | | | | | |
CabinetUsageID | Edm.Int32 | true | true |
false
| N/A | N/A | N/A | N/A | N/A | | |
CanBeAllocatedTo | Edm.Boolean | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | Editable value, if true, the cabinet is being used in auto-allocation process |
ContiguousUSpace | Edm.String | true | false |
true
| 255 | N/A | N/A | N/A | N/A | | A comma separated list of free Us |
HeatingLimit | Edm.Double | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
HeatThreshold | Edm.Double | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
KeyNumber | Edm.String | true | false |
false
| 15 | N/A | N/A | N/A | N/A | | |
LastAuditorAccountID | Edm.Int32 | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
LockNumber | Edm.String | true | false |
false
| 15 | N/A | N/A | N/A | N/A | | |
MaxFreeUSpace | Edm.Int32 | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | The maximum number of free Us |
TotalPlugs | Edm.Int32 | false | false |
true
| N/A | N/A | N/A | N/A | N/A | | |
WeightLimit | Edm.Double | true | false |
false
| N/A | 0 | 99999999999999.9999 | 18 | 4 | | |
WeightMaximum | Edm.Double | true | false |
false
| N/A | 0 | 99999999999999.9999 | 18 | 4 | | |
WeightThreshold | Edm.Double | true | false |
false
| N/A | 0 | 99999999999999.9999 | 18 | 4 | | |
Cabinet Navigational Properties
CabinetAssetMounting Entity
: AssetMounting
- Entity inheriting the AssetMounting entity, representing the association between the current asset and the cabinet in which the current asset is mounted.
Verb(s) | Required Permission(s) | Link | Description |
---|
CabinetAssetMounting Structural Properties
Property | Type | Nullable | Mandatory | Read-Only | String length | Min Value | Max Value | Precision | Max Dec Places | Is Only Date | Description |
---|
CabinetUNumber | Edm.Int32 | false | false |
true
| N/A | N/A | N/A | N/A | N/A | | The start U position in which the asset is mounted. |
LowerCabinetU | Edm.Int32 | false | false |
true
| N/A | N/A | N/A | N/A | N/A | | The bottom U position in which the asset is mounted. |
PlacementID | Nlyte.Model.MountingPlacement | false | false |
true
| N/A | N/A | N/A | N/A | N/A | | Represents the mounting position |
UDisplayLabel | Edm.Int32 | false | false |
true
| N/A | N/A | N/A | N/A | N/A | | The U label to be displayed, representing the top or the bottom U position, depending on the admin parameter |
CabinetAssetMounting Navigational Properties
No navigational properties
Verb(s) | Required Permission(s) | Link | Description |
---|
Get | WS-ReadMarker | integration/api/odata/CabinetMarkers, integration/api/odata/CabinetMarkers({key}) | |
Post | WS-AddMarker | integration/api/odata/CabinetMarkers | |
Patch | WS-ModifyMarker | integration/api/odata/CabinetMarkers({key}) | |
PostWithKey | WS-ModifyMarker | | |
CabinetMarker Structural Properties
Property | Type | Nullable | Mandatory | Read-Only | String length | Min Value | Max Value | Precision | Max Dec Places | Is Only Date | Description |
---|
AllowCollisions | Edm.Boolean | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
CabinetAssetID | Edm.Int32 | false | true |
false
| N/A | N/A | N/A | N/A | N/A | | |
CabinetMarkerID | Edm.Int32 | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
CabinetMarkerName | Edm.String | true | false |
false
| 100 | N/A | N/A | N/A | N/A | | |
CabinetUNumber | Edm.Int32 | true | false |
true
| N/A | N/A | N/A | N/A | N/A | | The U on which the asset is mounted |
Color | Edm.String | true | false |
false
| 20 | N/A | N/A | N/A | N/A | | |
Depth | Edm.Double | false | false |
true
| N/A | N/A | N/A | N/A | N/A | | |
Height | Edm.Decimal | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
LowerCabinetU | Edm.Int32 | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | The bottom U position in which the asset is mounted. |
MountingSide | Nlyte.Model.MountingSide | false | true |
false
| N/A | N/A | N/A | N/A | N/A | | Represents the mounting side, property of the asset that holds the mountable asset. |
MountingTypeID | Edm.Int32 | true | false |
true
| N/A | N/A | N/A | N/A | N/A | | |
Rotation | Edm.Int32 | false | false |
true
| N/A | N/A | N/A | N/A | N/A | | |
UDisplayLabel | Edm.Int32 | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | The U label to be displayed, representing the top or the bottom U position, depending on the admin parameter |
UMountingID | Edm.Int32 | true | false |
true
| N/A | N/A | N/A | N/A | N/A | | The foreign key identifying the entity providing details about the Cabinet U in which an asset is mounted. |
Width | Edm.Double | false | false |
true
| N/A | N/A | N/A | N/A | N/A | | |
Xcoord | Edm.Double | false | false |
true
| N/A | N/A | N/A | N/A | N/A | | |
Ycoord | Edm.Double | false | false |
true
| N/A | N/A | N/A | N/A | N/A | | |
YOffset | Edm.Double | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
Zcoord | Edm.Double | false | false |
true
| N/A | N/A | N/A | N/A | N/A | | |
CabinetMarker Navigational Properties
Verb(s) | Required Permission(s) | Link | Description |
---|
Get | WS-ReadCabinetMaterial | integration/api/odata/CabinetMaterials, integration/api/odata/CabinetMaterials({key}) | |
Post | WS-AddCabinetMaterial | integration/api/odata/CabinetMaterials | |
Patch | WS-ModifyCabinetMaterial | integration/api/odata/CabinetMaterials({key}) | |
PostWithKey | WS-ModifyCabinetMaterial | integration/api/odata/CabinetMaterials({key}) | |
Delete | WS-ModifyCabinetMaterial | integration/api/odata/CabinetMaterials({key}) | |
CabinetMaterial Structural Properties
Property | Type | Nullable | Mandatory | Read-Only | String length | Min Value | Max Value | Precision | Max Dec Places | Is Only Date | Description |
---|
AirflowTypeID | Nlyte.Model.AirflowTypeEnum | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | Selected air flow, from the available values defined in the administration area |
CabinetLockTypeID | Nlyte.Model.CabinetLockTypeEnum | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
FrontDoorTypeID | Nlyte.Model.CabinetDoorTypeEnum | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
InternalMountingRailDepth | Edm.Double | false | false |
false
| N/A | 0 | 9999.9999 | 8 | 4 | | |
InternalMountingRailHeight | Edm.Double | false | false |
false
| N/A | 0 | 9999.9999 | 8 | 4 | | Property connected with the UHeight property. InternalMountingRailHeight = UHeight * 44.45 |
InternalMountingRailWidth | Edm.Double | false | false |
false
| N/A | 0 | 9999.9999 | 8 | 4 | | |
ManufacturersMaxWattage | Edm.Double | true | false |
false
| N/A | 0.001 | 999.999 | 6 | 3 | | |
MaterialCategoryID | Edm.Int32 | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
MountingTypeID | Nlyte.Model.MountingTypeEnum | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
RearDoorTypeID | Nlyte.Model.CabinetDoorTypeEnum | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
RequiredPlugs | Edm.Int32 | false | true |
false
| N/A | N/A | N/A | N/A | N/A | | Value inserted by the user, while the material is in Planned status |
RequiresDiversePower | Edm.Boolean | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | Value available to be updated by the user only if RequiredPlugs TotalPlugs |
TopPanelID | Nlyte.Model.TopPanelEnum | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
TotalPlugs | Edm.Int32 | false | true |
false
| N/A | N/A | N/A | N/A | N/A | | Value inserted by the user, while the material is in Planned status |
UHeight | Edm.Int32 | false | false |
true
| N/A | N/A | N/A | N/A | N/A | | |
WorkableFootPrintFront | Edm.Double | false | false |
false
| N/A | 0 | 999999999999.9999 | 16 | 4 | | |
WorkableFootPrintHeight | Edm.Double | false | false |
false
| N/A | 0 | 999999999999.9999 | 16 | 4 | | |
WorkableFootPrintRear | Edm.Double | false | false |
false
| N/A | 0 | 999999999999.9999 | 16 | 4 | | |
CabinetMaterial Navigational Properties
Verb(s) | Required Permission(s) | Link | Description |
---|
Get | WS-ReadCabinetResourceMap | | |
Post | WS-AddCabinetResourceMap | | |
Patch | WS-ModifyCabinetResourceMap | | |
PostWithKey | WS-ModifyCabinetResourceMap | | |
Delete | WS-ModifyCabinetResourceMap | | |
Key(s) |
---|
CabinetResourceMapID |
CabinetResourceMap Structural Properties
Property | Type | Nullable | Mandatory | Read-Only | String length | Min Value | Max Value | Precision | Max Dec Places | Is Only Date | Description |
---|
CabinetResourceMapID | Edm.Int32 | false | false |
true
| N/A | N/A | N/A | N/A | N/A | | |
ConnectionTypeID | Nlyte.Model.CabinetMapResourceType | false | true |
false
| N/A | N/A | N/A | N/A | N/A | | |
ConsumerCabinetAssetID | Edm.Int32 | false | false |
true
| N/A | N/A | N/A | N/A | N/A | | |
ProviderCabinetAssetID | Edm.Int32 | false | false |
true
| N/A | N/A | N/A | N/A | N/A | | |
CabinetResourceMap Navigational Properties
Verb(s) | Required Permission(s) | Link | Description |
---|
Key(s) |
---|
CabinetAssetID |
CabinetUNumber |
CabinetU Structural Properties
Property | Type | Nullable | Mandatory | Read-Only | String length | Min Value | Max Value | Precision | Max Dec Places | Is Only Date | Description |
---|
AssetsOnU | Edm.String | true | false |
false
| 40 | N/A | N/A | N/A | N/A | | The asset ids of the asset mounted on the specified U |
CabinetAssetID | Edm.Int32 | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | The cabinet that holds the U |
CabinetUNumber | Edm.Int32 | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | The U on which the asset is mounted |
CabinetUState | Nlyte.Model.CabinetUStateEnum | false | |
false
| | | | | | | |
CabinetU Navigational Properties
Verb(s) | Required Permission(s) | Link | Description |
---|
CabinetUsage Structural Properties
Property | Type | Nullable | Mandatory | Read-Only | String length | Min Value | Max Value | Precision | Max Dec Places | Is Only Date | Description |
---|
CabinetUsageID | Edm.Int32 | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
ColourID | Edm.Int32 | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
Detail | Edm.String | false | true |
false
| 30 | N/A | N/A | N/A | N/A | | Cabinet usage description |
CabinetUsage Navigational Properties
No navigational properties
Verb(s) | Required Permission(s) | Link | Description |
---|
Get | WS-ReadNetworkConnection,WS-ReadAssetToAssetMapping | integration/api/odata/Connections, integration/api/odata/Connections({key}) | |
Cable Structural Properties
Property | Type | Nullable | Mandatory | Read-Only | String length | Min Value | Max Value | Precision | Max Dec Places | Is Only Date | Description |
---|
CableColourID | Edm.Int32 | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
CableID | Edm.Int32 | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
CableLength | Edm.Decimal | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
CableName | Edm.String | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
CableTypeID | Edm.Int32 | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
DestinationAssetID | Edm.Int32 | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
DestinationAssetName | Edm.String | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
DestinationAssetNumber | Edm.Int32 | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
DestinationCabinetID | Edm.Int32 | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
DestinationCabinetName | Edm.String | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
DestinationLocationID | Edm.Int32 | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
DestinationLocationName | Edm.String | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
DestinationPortGroupName | Edm.String | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
DestinationPortGroupType | Edm.String | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
DestinationPortID | Edm.Int32 | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
DestinationPortName | Edm.String | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
SourceAssetID | Edm.Int32 | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
SourceAssetName | Edm.String | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
SourceAssetNumber | Edm.Int32 | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
SourceCabinetID | Edm.Int32 | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
SourceCabinetName | Edm.String | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
SourceLocationID | Edm.Int32 | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
SourceLocationName | Edm.String | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
SourcePortGroupName | Edm.String | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
SourcePortGroupType | Edm.String | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
SourcePortID | Edm.Int32 | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
SourcePortName | Edm.String | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
Cable Navigational Properties
No navigational properties
Verb(s) | Required Permission(s) | Link | Description |
---|
CableConnection Structural Properties
Property | Type | Nullable | Mandatory | Read-Only | String length | Min Value | Max Value | Precision | Max Dec Places | Is Only Date | Description |
---|
CableColourID | Edm.Int32 | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
CableLength | Edm.Decimal | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
CableName | Edm.String | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
CableTrunkName | Edm.String | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
CableType | Edm.String | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
ConnectionType | Nlyte.Model.ConnectionTypeEnum | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
CrossSectionalArea | Edm.Decimal | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
EndAssetID | Edm.Int32 | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
EndCardName | Edm.String | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
EndConnectorName | Edm.String | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
EndConnectorType | Edm.String | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
EndDataType | Edm.Int32 | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
EndPortGroupID | Edm.Int32 | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
EndPortGroupName | Edm.String | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
EndPortGroupType | Edm.String | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
EndPortID | Edm.Int32 | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
EndPortLocationID | Nlyte.Model.PortLocation | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
EndPortName | Edm.String | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
EndPortState | Edm.Int32 | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
EndPortType | Edm.Int32 | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
EndSpeed | Edm.Int32 | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
GraphID | Edm.Int32 | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
HostingEndAssetID | Edm.Int32 | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
HostingStartAssetID | Edm.Int32 | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
IsProperPortGroupConnection | Edm.Boolean | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
MaxKva | Edm.Decimal | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
StartAssetID | Edm.Int32 | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
StartCardName | Edm.String | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
StartConnectorName | Edm.String | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
StartConnectorType | Edm.String | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
StartDataType | Edm.Int32 | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
StartPortGroupID | Edm.Int32 | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
StartPortGroupName | Edm.String | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
StartPortGroupType | Edm.String | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
StartPortID | Edm.Int32 | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
StartPortLocationID | Nlyte.Model.PortLocation | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
StartPortName | Edm.String | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
StartPortState | Edm.Int32 | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
StartPortType | Edm.Int32 | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
StartSpeed | Edm.Int32 | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
CableConnection Navigational Properties
No navigational properties
Verb(s) | Required Permission(s) | Link | Description |
---|
CardConnection Structural Properties
Property | Type | Nullable | Mandatory | Read-Only | String length | Min Value | Max Value | Precision | Max Dec Places | Is Only Date | Description |
---|
StartNodeCardPosition | Edm.String | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
CardConnection Navigational Properties
No navigational properties
Verb(s) | Required Permission(s) | Link | Description |
---|
Get | WS-ReadNetworkMaterial | integration/api/odata/CardNetworkMaterials, integration/api/odata/CardNetworkMaterials({key}) | |
Post | WS-AddNetworkMaterial | integration/api/odata/CardNetworkMaterials | |
PostWithKey | WS-ModifyNetworkMaterial | | |
Patch | WS-ModifyNetworkMaterial | integration/api/odata/CardNetworkMaterials({key}) | |
Delete | WS-ModifyNetworkMaterial | integration/api/odata/CardNetworkMaterials({key}) | |
CardNetworkMaterial Structural Properties
No structural properties
CardNetworkMaterial Navigational Properties
No navigational properties
Verb(s) | Required Permission(s) | Link | Description |
---|
CascadingForm Structural Properties
Property | Type | Nullable | Mandatory | Read-Only | String length | Min Value | Max Value | Precision | Max Dec Places | Is Only Date | Description |
---|
FormID | Edm.Int32 | true | true |
false
| N/A | N/A | N/A | N/A | N/A | | |
ID | Edm.Int32 | false | true |
false
| N/A | N/A | N/A | N/A | N/A | | |
OverridedFormName | Edm.String | false | true |
false
| 250 | N/A | N/A | N/A | N/A | | |
CascadingForm Navigational Properties
Verb(s) | Required Permission(s) | Link | Description |
---|
CascadingFormControl Structural Properties
No structural properties
CascadingFormControl Navigational Properties
No navigational properties
Verb(s) | Required Permission(s) | Link | Description |
---|
CascadingFormControlValue Structural Properties
No structural properties
CascadingFormControlValue Navigational Properties
No navigational properties
Verb(s) | Required Permission(s) | Link | Description |
---|
CatalogType Structural Properties
Property | Type | Nullable | Mandatory | Read-Only | String length | Min Value | Max Value | Precision | Max Dec Places | Is Only Date | Description |
---|
CatalogTypeID | Edm.Byte | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
Description | Edm.String | true | false |
false
| 20 | N/A | N/A | N/A | N/A | | |
CatalogType Navigational Properties
No navigational properties
Verb(s) | Required Permission(s) | Link | Description |
---|
Get | WS-ReadFloorPlan | integration/api/odata/CeilingMaterials, integration/api/odata/CeilingMaterials({key}) | |
Patch | WS-ModifyFloorPlan | | |
Put | WS-ModifyFloorPlan | | |
Post | WS-ModifyFloorPlan | | |
CeilingMaterial Structural Properties
Property | Type | Nullable | Mandatory | Read-Only | String length | Min Value | Max Value | Precision | Max Dec Places | Is Only Date | Description |
---|
Description | Edm.String | false | true |
false
| 50 | N/A | N/A | N/A | N/A | | |
ID | Edm.Int32 | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
CeilingMaterial Navigational Properties
No navigational properties
Chassis Entity
: Asset
- Asset created from a material of type chassis, entity inheriting the Nlyte.Model.Asset entity
Verb(s) | Required Permission(s) | Link | Description |
---|
Get | WS-ReadChassis | integration/api/odata/Chassis, integration/api/odata/Chassis({key}) | |
Patch | WS-ModifyChassis | integration/api/odata/Chassis({key}) | |
Delete | WS-ModifyChassis | integration/api/odata/Chassis({key}) | |
PostWithKey | WS-ModifyChassis | integration/api/odata/Chassis({key}) | |
Post | WS-AddChassis | integration/api/odata/Chassis | |
Chassis Structural Properties
Property | Type | Nullable | Mandatory | Read-Only | String length | Min Value | Max Value | Precision | Max Dec Places | Is Only Date | Description |
---|
AuditDate | Edm.DateTimeOffset | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
AuditStatusCorrect | Edm.Boolean | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
CurrentPowerFactor | Edm.Decimal | true | false |
true
| N/A | N/A | N/A | N/A | N/A | | Read-only property representing the percentage of power drawn by a PDD asset that is available to its consumers |
IsMasterRedundancyDevice | Edm.Boolean | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | Value inserted by the user |
LastAuditorAccountID | Edm.Int32 | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
OutputCount | Edm.Int32 | true | false |
true
| N/A | N/A | N/A | N/A | N/A | | |
PowerFactorOverride | Edm.Decimal | true | false |
false
| N/A | 0 | 1 | 3 | 2 | | Value provided by the user, overriding the CurrentPowerFactor value |
ProjectID | Edm.Int32 | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | The project id for the selected project. Projects are defined in the administration area. |
RealtimePowerFactor | Edm.Decimal | true | false |
true
| N/A | N/A | N/A | N/A | N/A | | Read-only value. |
StrategyID | Edm.Int32 | true | |
false
| | | | | | | |
TotalPlugs | Edm.Int32 | false | false |
true
| N/A | N/A | N/A | N/A | N/A | | |
TotalSystemSpace | Edm.Int32 | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
TrancheNumber | Edm.Int32 | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
Chassis Navigational Properties
ChassisAssetMounting Entity
: AssetMounting
- Entity inheriting the AssetMounting entity, representing the association between the current asset and the chassis in which the current asset is mounted.
Verb(s) | Required Permission(s) | Link | Description |
---|
ChassisAssetMounting Structural Properties
Property | Type | Nullable | Mandatory | Read-Only | String length | Min Value | Max Value | Precision | Max Dec Places | Is Only Date | Description |
---|
ColumnPosition | Edm.Int32 | false | false |
true
| N/A | N/A | N/A | N/A | N/A | | The starting column in the chassis in which the asset is mounted. |
RowPosition | Edm.Int32 | false | false |
true
| N/A | N/A | N/A | N/A | N/A | | The starting row in the chassis in which the asset is mounted. |
ChassisAssetMounting Navigational Properties
No navigational properties
Verb(s) | Required Permission(s) | Link | Description |
---|
Get | WS-ReadChassisMaterial | integration/api/odata/ChassisMaterials, integration/api/odata/ChassisMaterials({key}) | |
Post | WS-AddChassisMaterial | integration/api/odata/ChassisMaterials | |
PostWithKey | WS-ModifyChassisMaterial | integration/api/odata/ChassisMaterials({key}) | |
Patch | WS-ModifyChassisMaterial | integration/api/odata/ChassisMaterials({key}) | |
Delete | WS-ModifyChassisMaterial | integration/api/odata/ChassisMaterials({key}) | |
ChassisMaterial Structural Properties
Property | Type | Nullable | Mandatory | Read-Only | String length | Min Value | Max Value | Precision | Max Dec Places | Is Only Date | Description |
---|
AirflowTypeID | Nlyte.Model.AirflowTypeEnum | false | true |
false
| N/A | N/A | N/A | N/A | N/A | | Selected air flow, from the available values defined in the administration area |
CalculatedMaxKW | Edm.Decimal | true | false |
true
| N/A | N/A | N/A | N/A | N/A | | read-only property, provided by the service, calculated based on MaxV |
CalculatedMpafPowerConsumption | Edm.Decimal | true | false |
true
| N/A | N/A | N/A | N/A | N/A | | Read-only property, value provided by the service based on the PublishedPowerConsumption and the MpafOverride |
ConsumerPowerFactor | Edm.Decimal | false | false |
true
| N/A | N/A | N/A | N/A | N/A | | Read-only property representing the percentage of power drawn by a PDD material that is available to its asset consumers |
DistributorPowerFactor | Edm.Decimal | false | false |
true
| N/A | N/A | N/A | N/A | N/A | | |
IsSuppliedMaterialUpdated | Edm.Boolean | false | false |
true
| N/A | N/A | N/A | N/A | N/A | | read-only property, set to true when a user modifies ChassisMaterialSlots |
MaterialCategoryID | Edm.Int32 | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
MaxA | Edm.Decimal | true | false |
false
| N/A | 0 | 99999.999 | 8 | 3 | | |
MaxV | Edm.Decimal | true | false |
false
| N/A | 0 | 99999.999 | 8 | 3 | | |
MountingTypeID | Nlyte.Model.MountingTypeEnum | false | true |
false
| N/A | N/A | N/A | N/A | N/A | | |
MpafOverride | Edm.Decimal | true | false |
false
| N/A | 0 | 999 | 6 | 3 | | Value inserted by the user, while the material is in Planned status |
NumberOfColumnsBack | Edm.Int32 | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | Property representing the number of columns present in the back of the chassis |
NumberOfColumnsFront | Edm.Int32 | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | Property representing the number of columns present in the front of the chassis |
NumberOfRowsBack | Edm.Int32 | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | Property representing the number of rows present in the back of the chassis |
NumberOfRowsFront | Edm.Int32 | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | Property representing the number of rows present in the front of the chassis |
PlugType | Edm.String | true | false |
false
| 50 | N/A | N/A | N/A | N/A | | Property selected from the available types, available as lookups InputConnectorTypes |
PowerTypeID | Nlyte.Model.PowerTypeEnum | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | Power type: phased or direct current |
PublishedPowerConsumption | Edm.Decimal | false | false |
false
| N/A | 0 | 999 | 6 | 3 | | Value inserted by the user, while the material is in Planned status |
RequiredPlugs | Edm.Int32 | false | true |
false
| N/A | N/A | N/A | N/A | N/A | | Value inserted by the user, while the material is in Planned status |
RequiresDiversePower | Edm.Boolean | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | Value available to be updated by the user only if RequiredPlugs TotalPlugs |
TotalPlugs | Edm.Int32 | false | true |
false
| N/A | N/A | N/A | N/A | N/A | | Value inserted by the user, while the material is in Planned status |
UHeight | Edm.Int64 | false | false |
true
| N/A | N/A | N/A | N/A | N/A | | |
WorkableFootPrintFront | Edm.Double | false | false |
false
| N/A | 0 | 999999999999.9999 | 16 | 4 | | |
WorkableFootPrintHeight | Edm.Double | false | false |
false
| N/A | 0 | 999999999999.9999 | 16 | 4 | | |
WorkableFootPrintRear | Edm.Double | false | false |
false
| N/A | 0 | 999999999999.9999 | 16 | 4 | | |
ChassisMaterial Navigational Properties
Verb(s) | Required Permission(s) | Link | Description |
---|
Get | WS-ReadChassisMaterial | | |
Patch | WS-ModifyChassisMaterial | | |
PostWithKey | WS-ModifyChassisMaterial | | |
ChassisMaterialSlot Structural Properties
Property | Type | Nullable | Mandatory | Read-Only | String length | Min Value | Max Value | Precision | Max Dec Places | Is Only Date | Description |
---|
ChassisMaterialID | Edm.Int32 | false | false |
true
| N/A | N/A | N/A | N/A | N/A | | |
ColumnPosition | Edm.Byte | false | false |
true
| N/A | N/A | N/A | N/A | N/A | | |
ID | Edm.Int32 | false | false |
true
| N/A | N/A | N/A | N/A | N/A | | |
MountingSide | Nlyte.Model.MountingSide | false | |
false
| | | | | | | |
RowPosition | Edm.Byte | false | false |
true
| N/A | N/A | N/A | N/A | N/A | | |
SlotName | Edm.String | true | true |
false
| 10 | N/A | N/A | N/A | N/A | | |
ChassisMaterialSlot Navigational Properties
Verb(s) | Required Permission(s) | Link | Description |
---|
Get | WS-ReadChassisMountedAssetMap | | |
Post | WS-AddChassisMountedAssetMap | | |
Patch | WS-ModifyChassisMountedAssetMap | | |
PostWithKey | WS-ModifyChassisMountedAssetMap | | |
Delete | WS-ModifyChassisMountedAssetMap | | |
Key(s) |
---|
ChassisMountedAssetMapID |
ChassisMountedAssetMap Structural Properties
Property | Type | Nullable | Mandatory | Read-Only | String length | Min Value | Max Value | Precision | Max Dec Places | Is Only Date | Description |
---|
ChassisAssetID | Edm.Int32 | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
ChassisMountedAssetMapID | Edm.Int32 | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
ColumnPosition | Edm.Byte | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
MountedAssetID | Edm.Int32 | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
MountingSide | Nlyte.Model.MountingSide | false | |
false
| | | | | | | |
RowPosition | Edm.Byte | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
SlotName | Edm.String | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
ChassisMountedAssetMap Navigational Properties
Verb(s) | Required Permission(s) | Link | Description |
---|
Get | WS-ReadChassis | | |
Patch | WS-ModifyChassis | | |
PostWithKey | WS-ModifyChassis | | |
ChassisSlots Structural Properties
Property | Type | Nullable | Mandatory | Read-Only | String length | Min Value | Max Value | Precision | Max Dec Places | Is Only Date | Description |
---|
ChassisAssetID | Edm.Int32 | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
ColumnPosition | Edm.Byte | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
ID | Edm.Int32 | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
MountingSide | Nlyte.Model.MountingSide | false | |
false
| | | | | | | |
RowPosition | Edm.Byte | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
SlotName | Edm.String | true | false |
false
| 10 | N/A | N/A | N/A | N/A | | Chassis Slot Name. This must be unique for the same orientation in the same chassis. |
ChassisSlots Navigational Properties
Verb(s) | Required Permission(s) | Link | Description |
---|
CheckBoxControl Structural Properties
No structural properties
CheckBoxControl Navigational Properties
No navigational properties
Verb(s) | Required Permission(s) | Link | Description |
---|
CheckBoxControlValue Structural Properties
No structural properties
CheckBoxControlValue Navigational Properties
No navigational properties
Verb(s) | Required Permission(s) | Link | Description |
---|
CloudProvider Structural Properties
Property | Type | Nullable | Mandatory | Read-Only | String length | Min Value | Max Value | Precision | Max Dec Places | Is Only Date | Description |
---|
CloudProviderId | Edm.Int32 | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
Detail | Edm.String | false | true |
false
| 250 | N/A | N/A | N/A | N/A | | Cloud provider description |
CloudProvider Navigational Properties
No navigational properties
Verb(s) | Required Permission(s) | Link | Description |
---|
ComboBoxControl Structural Properties
Property | Type | Nullable | Mandatory | Read-Only | String length | Min Value | Max Value | Precision | Max Dec Places | Is Only Date | Description |
---|
Items | Collection(Nlyte.Model.ComboBoxControlItem) | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
PredefinedListType | Nlyte.Model.PredefinedListType | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
UseIntegrationTag | Edm.Boolean | false | true |
false
| N/A | N/A | N/A | N/A | N/A | | |
ComboBoxControl Navigational Properties
No navigational properties
Verb(s) | Required Permission(s) | Link | Description |
---|
ComboBoxControlValue Structural Properties
No structural properties
ComboBoxControlValue Navigational Properties
No navigational properties
Verb(s) | Required Permission(s) | Link | Description |
---|
CompleteActivityControl Structural Properties
No structural properties
CompleteActivityControl Navigational Properties
No navigational properties
Verb(s) | Required Permission(s) | Link | Description |
---|
CompleteActivityControlValue Structural Properties
No structural properties
CompleteActivityControlValue Navigational Properties
No navigational properties
Verb(s) | Required Permission(s) | Link | Description |
---|
ConsumerDistributorMaterialType Structural Properties
Property | Type | Nullable | Mandatory | Read-Only | String length | Min Value | Max Value | Precision | Max Dec Places | Is Only Date | Description |
---|
ConsumerPowerFactor | Edm.Double | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
DistributorPowerFactor | Edm.Decimal | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
ConsumerDistributorMaterialType Navigational Properties
No navigational properties
Verb(s) | Required Permission(s) | Link | Description |
---|
ConsumerMaterial Structural Properties
Property | Type | Nullable | Mandatory | Read-Only | String length | Min Value | Max Value | Precision | Max Dec Places | Is Only Date | Description |
---|
MaterialID | Edm.Int32 | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
MpafOverride | Edm.Decimal | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | Value inserted by the user, while the material is in Planned status |
PublishedPowerConsumption | Edm.Decimal | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | Value inserted by the user, while the material is in Planned status |
RequiresDiversePower | Edm.Boolean | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
ConsumerMaterial Navigational Properties
Verb(s) | Required Permission(s) | Link | Description |
---|
ConsumerMaterialType Structural Properties
Property | Type | Nullable | Mandatory | Read-Only | String length | Min Value | Max Value | Precision | Max Dec Places | Is Only Date | Description |
---|
ConsumerPowerFactor | Edm.Double | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
ConsumerPowerFactor | Edm.Double | false | |
false
| | | | | | | |
ConsumerMaterialType Navigational Properties
No navigational properties
Verb(s) | Required Permission(s) | Link | Description |
---|
Key(s) |
---|
FormControlID |
AssetID |
ControlAsset Structural Properties
Property | Type | Nullable | Mandatory | Read-Only | String length | Min Value | Max Value | Precision | Max Dec Places | Is Only Date | Description |
---|
AssetID | Edm.Int32 | false | false |
true
| N/A | N/A | N/A | N/A | N/A | | |
AssetName | Edm.String | true | false |
true
| N/A | N/A | N/A | N/A | N/A | | |
AssetNumber | Edm.Int32 | true | false |
true
| N/A | N/A | N/A | N/A | N/A | | |
CabinetAssetID | Edm.Int32 | true | false |
true
| N/A | N/A | N/A | N/A | N/A | | |
CabinetAssetName | Edm.String | true | false |
true
| N/A | N/A | N/A | N/A | N/A | | |
CabinetUsage | Edm.String | true | false |
true
| N/A | N/A | N/A | N/A | N/A | | |
CabinetUsageID | Edm.Int32 | true | false |
true
| N/A | N/A | N/A | N/A | N/A | | |
CustomFieldName | Edm.String | true | false |
true
| N/A | N/A | N/A | N/A | N/A | | |
CustomFieldValueCheckBox | Edm.Boolean | true | false |
true
| N/A | N/A | N/A | N/A | N/A | | |
CustomFieldValueDate | Edm.DateTimeOffset | true | false |
true
| N/A | N/A | N/A | N/A | N/A | | |
CustomFieldValueLookup | Edm.Int32 | true | false |
true
| N/A | N/A | N/A | N/A | N/A | | |
CustomFieldValueString | Edm.String | true | false |
true
| N/A | N/A | N/A | N/A | N/A | | |
DuplicateLocationGroupName | Edm.String | true | false |
true
| N/A | N/A | N/A | N/A | N/A | | |
FormControlID | Edm.Int32 | false | false |
true
| N/A | N/A | N/A | N/A | N/A | | |
GridReference | Edm.String | true | false |
true
| N/A | N/A | N/A | N/A | N/A | | |
GridReferenceColumn | Edm.String | true | false |
true
| N/A | N/A | N/A | N/A | N/A | | |
GridReferenceLayer | Edm.String | true | false |
true
| N/A | N/A | N/A | N/A | N/A | | |
GridReferenceRow | Edm.String | true | false |
true
| N/A | N/A | N/A | N/A | N/A | | |
HeatingLimit | Edm.Double | true | false |
true
| N/A | N/A | N/A | N/A | N/A | | |
HeatThreshold | Edm.Double | true | false |
true
| N/A | N/A | N/A | N/A | N/A | | |
LocationGroupID | Edm.Int32 | false | false |
true
| N/A | N/A | N/A | N/A | N/A | | |
LocationGroupName | Edm.String | true | false |
true
| N/A | N/A | N/A | N/A | N/A | | |
MaterialID | Edm.Int32 | false | false |
true
| N/A | N/A | N/A | N/A | N/A | | |
MaterialName | Edm.String | true | false |
true
| N/A | N/A | N/A | N/A | N/A | | |
MaterialNumber | Edm.Int32 | false | false |
true
| N/A | N/A | N/A | N/A | N/A | | |
MaterialSubtypeID | Edm.Int32 | true | false |
true
| N/A | N/A | N/A | N/A | N/A | | |
MaterialTypeID | Edm.Int32 | true | false |
true
| N/A | N/A | N/A | N/A | N/A | | |
OperationalStatus | Nlyte.Model.OperationalStatusEnum | false | false |
true
| N/A | N/A | N/A | N/A | N/A | | |
PONumber | Edm.String | true | false |
true
| N/A | N/A | N/A | N/A | N/A | | |
PRNumber | Edm.String | true | false |
true
| N/A | N/A | N/A | N/A | N/A | | |
RecordStatus | Nlyte.Model.RecordStatusEnum | false | false |
true
| N/A | N/A | N/A | N/A | N/A | | |
RFIDTag | Edm.String | true | false |
true
| N/A | N/A | N/A | N/A | N/A | | |
SAPAssetNumber | Edm.String | true | false |
true
| N/A | N/A | N/A | N/A | N/A | | |
SerialNumber | Edm.String | true | false |
true
| N/A | N/A | N/A | N/A | N/A | | |
ServiceRequestID | Edm.Int32 | true | false |
true
| N/A | N/A | N/A | N/A | N/A | | |
Tag | Edm.String | true | false |
true
| N/A | N/A | N/A | N/A | N/A | | |
TaskInstanceID | Edm.Int32 | true | false |
true
| N/A | N/A | N/A | N/A | N/A | | |
UDisplayLabel | Edm.Int32 | true | false |
true
| N/A | N/A | N/A | N/A | N/A | | Cabinet U Display Label |
ControlAsset Navigational Properties
No navigational properties
Verb(s) | Required Permission(s) | Link | Description |
---|
CreateAssetControl Structural Properties
Property | Type | Nullable | Mandatory | Read-Only | String length | Min Value | Max Value | Precision | Max Dec Places | Is Only Date | Description |
---|
MaterialTypeId | Nlyte.Model.CreateAssetMaterialType | false | true |
false
| N/A | N/A | N/A | N/A | N/A | | |
CreateAssetControl Navigational Properties
No navigational properties
Verb(s) | Required Permission(s) | Link | Description |
---|
CreateAssetControlValue Structural Properties
Property | Type | Nullable | Mandatory | Read-Only | String length | Min Value | Max Value | Precision | Max Dec Places | Is Only Date | Description |
---|
AssetID | Edm.Int32 | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
CreateAssetControlValue Navigational Properties
No navigational properties
Verb(s) | Required Permission(s) | Link | Description |
---|
Key(s) |
---|
CrossSectionalAreaID |
CrossSectionalArea Structural Properties
Property | Type | Nullable | Mandatory | Read-Only | String length | Min Value | Max Value | Precision | Max Dec Places | Is Only Date | Description |
---|
CrossSectionalAreaID | Edm.Int32 | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
Description | Edm.Decimal | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
CrossSectionalArea Navigational Properties
No navigational properties
Verb(s) | Required Permission(s) | Link | Description |
---|
Culture Structural Properties
Property | Type | Nullable | Mandatory | Read-Only | String length | Min Value | Max Value | Precision | Max Dec Places | Is Only Date | Description |
---|
ID | Edm.Int32 | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
Name | Edm.String | true | false |
false
| 50 | N/A | N/A | N/A | N/A | | |
Culture Navigational Properties
No navigational properties
Verb(s) | Required Permission(s) | Link | Description |
---|
Get | WS-ReadCustomFieldAirConditioning,WS-ReadCustomFieldAuxiliary,WS-ReadCustomFieldCabinet,WS-ReadCustomFieldChassis,WS-ReadCustomFieldReceptacle,WS-ReadCustomFieldKVMSwitch,WS-ReadCustomFieldNetwork,WS-ReadCustomFieldPDU,WS-ReadCustomFieldPeripheral,WS-ReadCustomFieldPowerStrip,WS-ReadCustomFieldServer,WS-ReadCustomFieldStaticSwitch,WS-ReadCustomFieldUPS | | |
Post | WS-ModifyCustomFieldAirConditioning,WS-ModifyCustomFieldAuxiliary,WS-ModifyCustomFieldCabinet,WS-ModifyCustomFieldChassis,WS-ModifyCustomFieldReceptacle,WS-ModifyCustomFieldKVMSwitch,WS-ModifyCustomFieldNetwork,WS-ModifyCustomFieldPDU,WS-ModifyCustomFieldPeripheral,WS-ModifyCustomFieldPowerStrip,WS-ModifyCustomFieldServer,WS-ModifyCustomFieldStaticSwitch,WS-ModifyCustomFieldUPS | | |
Patch | WS-ModifyCustomFieldAirConditioning,WS-ModifyCustomFieldAuxiliary,WS-ModifyCustomFieldCabinet,WS-ModifyCustomFieldChassis,WS-ModifyCustomFieldReceptacle,WS-ModifyCustomFieldKVMSwitch,WS-ModifyCustomFieldNetwork,WS-ModifyCustomFieldPDU,WS-ModifyCustomFieldPeripheral,WS-ModifyCustomFieldPowerStrip,WS-ModifyCustomFieldServer,WS-ModifyCustomFieldStaticSwitch,WS-ModifyCustomFieldUPS | | |
Delete | WS-ModifyCustomFieldAirConditioning,WS-ModifyCustomFieldAuxiliary,WS-ModifyCustomFieldCabinet,WS-ModifyCustomFieldChassis,WS-ModifyCustomFieldReceptacle,WS-ModifyCustomFieldKVMSwitch,WS-ModifyCustomFieldNetwork,WS-ModifyCustomFieldPDU,WS-ModifyCustomFieldPeripheral,WS-ModifyCustomFieldPowerStrip,WS-ModifyCustomFieldServer,WS-ModifyCustomFieldStaticSwitch,WS-ModifyCustomFieldUPS | | |
Key(s) |
---|
DataFieldAssetValueID |
CustomField Structural Properties
Property | Type | Nullable | Mandatory | Read-Only | String length | Min Value | Max Value | Precision | Max Dec Places | Is Only Date | Description |
---|
AssetID | Edm.Int32 | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | Asset for which the custom field value was defined |
DataFieldAssetValueID | Edm.Int32 | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
DataLabel | Edm.String | true | false |
false
| 50 | N/A | N/A | N/A | N/A | | |
DataValueCheckBox | Edm.Boolean | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | Depending on the custom field type, value is provided. |
DataValueDate | Edm.DateTimeOffset | true | false |
false
| N/A | N/A | N/A | N/A | N/A | IsOnlyDate | Depending on the custom field type, value is provided. |
DataValueFieldName | Edm.String | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
DataValueLookup | Edm.Int32 | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | Depending on the custom field type, value is provided. |
DataValueString | Edm.String | true | false |
false
| 1000 | N/A | N/A | N/A | N/A | | Depending on the custom field type, value is provided. |
CustomField Navigational Properties
Verb(s) | Required Permission(s) | Link | Description |
---|
Get | WS-ReadCustomFieldAirConditioning,WS-ReadCustomFieldAuxiliary,WS-ReadCustomFieldCabinet,WS-ReadCustomFieldChassis,WS-ReadCustomFieldReceptacle,WS-ReadCustomFieldKVMSwitch,WS-ReadCustomFieldNetwork,WS-ReadCustomFieldPDU,WS-ReadCustomFieldPeripheral,WS-ReadCustomFieldPowerStrip,WS-ReadCustomFieldServer,WS-ReadCustomFieldStaticSwitch,WS-ReadCustomFieldUPS | | |
Post | WS-ModifyCustomFieldAirConditioning,WS-ModifyCustomFieldAuxiliary,WS-ModifyCustomFieldCabinet,WS-ModifyCustomFieldChassis,WS-ModifyCustomFieldReceptacle,WS-ModifyCustomFieldKVMSwitch,WS-ModifyCustomFieldNetwork,WS-ModifyCustomFieldPDU,WS-ModifyCustomFieldPeripheral,WS-ModifyCustomFieldPowerStrip,WS-ModifyCustomFieldServer,WS-ModifyCustomFieldStaticSwitch,WS-ModifyCustomFieldUPS | | |
Patch | WS-ModifyCustomFieldAirConditioning,WS-ModifyCustomFieldAuxiliary,WS-ModifyCustomFieldCabinet,WS-ModifyCustomFieldChassis,WS-ModifyCustomFieldReceptacle,WS-ModifyCustomFieldKVMSwitch,WS-ModifyCustomFieldNetwork,WS-ModifyCustomFieldPDU,WS-ModifyCustomFieldPeripheral,WS-ModifyCustomFieldPowerStrip,WS-ModifyCustomFieldServer,WS-ModifyCustomFieldStaticSwitch,WS-ModifyCustomFieldUPS | | |
Delete | WS-ModifyCustomFieldAirConditioning,WS-ModifyCustomFieldAuxiliary,WS-ModifyCustomFieldCabinet,WS-ModifyCustomFieldChassis,WS-ModifyCustomFieldReceptacle,WS-ModifyCustomFieldKVMSwitch,WS-ModifyCustomFieldNetwork,WS-ModifyCustomFieldPDU,WS-ModifyCustomFieldPeripheral,WS-ModifyCustomFieldPowerStrip,WS-ModifyCustomFieldServer,WS-ModifyCustomFieldStaticSwitch,WS-ModifyCustomFieldUPS | | |
Key(s) |
---|
CustomFieldLookupValueID |
CustomFieldLookupValue Structural Properties
Property | Type | Nullable | Mandatory | Read-Only | String length | Min Value | Max Value | Precision | Max Dec Places | Is Only Date | Description |
---|
Active | Edm.Boolean | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
CustomFieldLookupValueID | Edm.Int32 | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
DataFieldID | Edm.Int32 | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
Detail | Edm.String | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
CustomFieldLookupValue Navigational Properties
Verb(s) | Required Permission(s) | Link | Description |
---|
CustomFieldType Structural Properties
Property | Type | Nullable | Mandatory | Read-Only | String length | Min Value | Max Value | Precision | Max Dec Places | Is Only Date | Description |
---|
AdvancedSearchable | Edm.Boolean | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
DataType | Edm.String | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
ID | Edm.Int32 | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
ItemOrder | Edm.Int32 | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
MaterialType | Edm.String | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
MaterialTypeID | Edm.Int32 | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
Name | Edm.String | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
CustomFieldType Navigational Properties
Verb(s) | Required Permission(s) | Link | Description |
---|
Key(s) |
---|
DataConfidentialityID |
DataConfidentiality Structural Properties
Property | Type | Nullable | Mandatory | Read-Only | String length | Min Value | Max Value | Precision | Max Dec Places | Is Only Date | Description |
---|
DataConfidentialityID | Edm.Int32 | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
Detail | Edm.String | false | true |
false
| 30 | N/A | N/A | N/A | N/A | | Data confidentiality description |
DataConfidentiality Navigational Properties
No navigational properties
Verb(s) | Required Permission(s) | Link | Description |
---|
DataRecovery Structural Properties
Property | Type | Nullable | Mandatory | Read-Only | String length | Min Value | Max Value | Precision | Max Dec Places | Is Only Date | Description |
---|
DataRecoveryID | Edm.Int32 | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
Detail | Edm.String | false | true |
false
| 30 | N/A | N/A | N/A | N/A | | Data recovery description |
DataRecovery Navigational Properties
No navigational properties
Verb(s) | Required Permission(s) | Link | Description |
---|
DatePickerControl Structural Properties
Property | Type | Nullable | Mandatory | Read-Only | String length | Min Value | Max Value | Precision | Max Dec Places | Is Only Date | Description |
---|
DefaultDate | Edm.DateTimeOffset | true | false |
false
| N/A | N/A | N/A | N/A | N/A | IsOnlyDate | |
PreventSelectingExcludedDates | Edm.Boolean | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
DatePickerControl Navigational Properties
No navigational properties
Verb(s) | Required Permission(s) | Link | Description |
---|
DatePickerControlValue Structural Properties
No structural properties
DatePickerControlValue Navigational Properties
No navigational properties
Verb(s) | Required Permission(s) | Link | Description |
---|
DecommissionAssetControl Structural Properties
No structural properties
DecommissionAssetControl Navigational Properties
No navigational properties
Verb(s) | Required Permission(s) | Link | Description |
---|
DecommissionAssetControlValue Structural Properties
Property | Type | Nullable | Mandatory | Read-Only | String length | Min Value | Max Value | Precision | Max Dec Places | Is Only Date | Description |
---|
ProcessedAssetIDs | Collection(Edm.Int32) | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
DecommissionAssetControlValue Navigational Properties
No navigational properties
Verb(s) | Required Permission(s) | Link | Description |
---|
Get | WS-ReadRoomPlan | | |
Patch | WS-ModifyRoomPlan | | |
Put | WS-ModifyRoomPlan | | |
Delete | WS-ModifyRoomPlan | | |
Post | WS-ModifyRoomPlan | | |
DisplayProperties Structural Properties
Property | Type | Nullable | Mandatory | Read-Only | String length | Min Value | Max Value | Precision | Max Dec Places | Is Only Date | Description |
---|
Alpha | Edm.Int32 | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
BorderColour | Edm.Int32 | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
FillColour | Edm.Int32 | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
FontAlignment | Edm.String | true | true |
false
| 50 | N/A | N/A | N/A | N/A | | |
FontBackgroundColour | Edm.Int32 | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
FontColour | Edm.Int32 | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
FontFamily | Edm.String | true | true |
false
| 50 | N/A | N/A | N/A | N/A | | |
FontSize | Edm.Decimal | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
ID | Edm.Int32 | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
LineColour | Edm.Int32 | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
SaveAction | Nlyte.Model.SaveActionEnum | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
DisplayProperties Navigational Properties
No navigational properties
Verb(s) | Required Permission(s) | Link | Description |
---|
DistributorMaterial Structural Properties
Property | Type | Nullable | Mandatory | Read-Only | String length | Min Value | Max Value | Precision | Max Dec Places | Is Only Date | Description |
---|
DeratingFactor | Edm.Decimal | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
MaterialID | Edm.Int32 | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
MaxA | Edm.Decimal | true | false |
false
| N/A | 0 | 99999.999 | 8 | 3 | | |
MaxKVA | Edm.Decimal | true | false |
false
| N/A | 0 | 99999999.9999 | 12 | 4 | | |
MaxKW | Edm.Decimal | true | false |
false
| N/A | 0 | 99999999.9999 | 12 | 4 | | |
MaxV | Edm.Decimal | true | false |
false
| N/A | 0 | 99999.999 | 8 | 3 | | |
OutputCount | Edm.Int32 | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
PowerFactor | Edm.Decimal | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | Read-only property representing the percentage of power drawn by a PDD material that is available to its asset consumers |
DistributorMaterial Navigational Properties
Verb(s) | Required Permission(s) | Link | Description |
---|
DistributorMaterialType Structural Properties
Property | Type | Nullable | Mandatory | Read-Only | String length | Min Value | Max Value | Precision | Max Dec Places | Is Only Date | Description |
---|
DistributorPowerFactor | Edm.Decimal | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
DistributorMaterialType Navigational Properties
No navigational properties
Verb(s) | Required Permission(s) | Link | Description |
---|
EditAssetControl Structural Properties
Property | Type | Nullable | Mandatory | Read-Only | String length | Min Value | Max Value | Precision | Max Dec Places | Is Only Date | Description |
---|
MaterialTypeIds | Collection(Nlyte.Model.MaterialTypeEnum) | false | true |
false
| N/A | N/A | N/A | N/A | N/A | | |
EditAssetControl Navigational Properties
No navigational properties
Verb(s) | Required Permission(s) | Link | Description |
---|
EditAssetControlValue Structural Properties
No structural properties
EditAssetControlValue Navigational Properties
No navigational properties
Verb(s) | Required Permission(s) | Link | Description |
---|
EquipmentPickerAsset Structural Properties
Property | Type | Nullable | Mandatory | Read-Only | String length | Min Value | Max Value | Precision | Max Dec Places | Is Only Date | Description |
---|
AssetID | Edm.Int32 | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
EquipmentPickerControlValueID | Edm.Int32 | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
ID | Edm.Int32 | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
NewAssetName | Edm.String | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
Snapshot | Edm.Boolean | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
SnapshotValue | Edm.String | true | false |
false
| 2147483647 | N/A | N/A | N/A | N/A | | |
WasActionExecuted | Edm.Boolean | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
EquipmentPickerAsset Navigational Properties
Verb(s) | Required Permission(s) | Link | Description |
---|
EquipmentPickerControl Structural Properties
Property | Type | Nullable | Mandatory | Read-Only | String length | Min Value | Max Value | Precision | Max Dec Places | Is Only Date | Description |
---|
AllowMultipleAssets | Edm.Boolean | false | true |
false
| N/A | N/A | N/A | N/A | N/A | | |
MaterialTypeIds | Collection(Nlyte.Model.MaterialTypeEnum) | false | true |
false
| N/A | N/A | N/A | N/A | N/A | | |
RowSpan | Edm.Int32 | false | true |
false
| N/A | N/A | N/A | N/A | N/A | | |
TotalText | Edm.String | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
EquipmentPickerControl Navigational Properties
No navigational properties
Verb(s) | Required Permission(s) | Link | Description |
---|
EquipmentPickerControlValue Structural Properties
No structural properties
EquipmentPickerControlValue Navigational Properties
No navigational properties
Verb(s) | Required Permission(s) | Link | Description |
---|
Post | WS-AddExclusionDate | integration/api/odata/ExclusionDates | |
Patch | WS-ModifyExclusionDate | integration/api/odata/ExclusionDates({key}) | |
Delete | WS-ModifyExclusionDate | integration/api/odata/ExclusionDates({key}) | |
ExclusionDate Structural Properties
Property | Type | Nullable | Mandatory | Read-Only | String length | Min Value | Max Value | Precision | Max Dec Places | Is Only Date | Description |
---|
AssigneeID | Edm.Int32 | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
EndDate | Edm.DateTimeOffset | false | false |
false
| N/A | N/A | N/A | N/A | N/A | IsOnlyDate | |
ID | Edm.Int32 | false | false |
true
| N/A | N/A | N/A | N/A | N/A | | |
IsInclusion | Edm.Boolean | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
Name | Edm.String | false | true |
false
| 100 | N/A | N/A | N/A | N/A | | |
StartDate | Edm.DateTimeOffset | false | false |
false
| N/A | N/A | N/A | N/A | N/A | IsOnlyDate | |
ExclusionDate Navigational Properties
Verb(s) | Required Permission(s) | Link | Description |
---|
ExtendedRecordListItem Structural Properties
Property | Type | Nullable | Mandatory | Read-Only | String length | Min Value | Max Value | Precision | Max Dec Places | Is Only Date | Description |
---|
ColourID | Edm.Int32 | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
ExtendedRecordListItem Navigational Properties
No navigational properties
Verb(s) | Required Permission(s) | Link | Description |
---|
FieldPickerControl Structural Properties
Property | Type | Nullable | Mandatory | Read-Only | String length | Min Value | Max Value | Precision | Max Dec Places | Is Only Date | Description |
---|
EntityType | Nlyte.Model.FieldPickerEntityType | false | true |
false
| N/A | N/A | N/A | N/A | N/A | | |
Parameter | Edm.String | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
FieldPickerControl Navigational Properties
No navigational properties
Verb(s) | Required Permission(s) | Link | Description |
---|
FieldPickerControlValue Structural Properties
No structural properties
FieldPickerControlValue Navigational Properties
No navigational properties
Verb(s) | Required Permission(s) | Link | Description |
---|
Get | WS-ReadFile | | |
Delete | WS-ModifyFile | | |
File Structural Properties
Property | Type | Nullable | Mandatory | Read-Only | String length | Min Value | Max Value | Precision | Max Dec Places | Is Only Date | Description |
---|
DateUpdated | Edm.DateTimeOffset | true | false |
true
| N/A | N/A | N/A | N/A | N/A | | |
EntityID | Edm.Int32 | false | false |
true
| N/A | N/A | N/A | N/A | N/A | | |
Extension | Edm.String | true | false |
true
| 10 | N/A | N/A | N/A | N/A | | |
ModifiedCount | Edm.Int32 | true | false |
true
| N/A | N/A | N/A | N/A | N/A | | |
Name | Edm.String | false | false |
true
| 200 | N/A | N/A | N/A | N/A | | |
Size | Edm.Int32 | true | false |
true
| N/A | N/A | N/A | N/A | N/A | | |
UploadedBy | Edm.String | true | false |
true
| 152 | N/A | N/A | N/A | N/A | | |
File Navigational Properties
No navigational properties
Verb(s) | Required Permission(s) | Link | Description |
---|
Get | WS-ReadFloorPlan | integration/api/odata/Floors, integration/api/odata/Floors({key}) | |
Patch | WS-ModifyFloorPlan | | |
Put | WS-ModifyFloorPlan | integration/api/odata/Floors({key}) | |
Post | WS-ModifyFloorPlan | integration/api/odata/Floors | |
Floor Structural Properties
Property | Type | Nullable | Mandatory | Read-Only | String length | Min Value | Max Value | Precision | Max Dec Places | Is Only Date | Description |
---|
CoolingLimit | Edm.Decimal | true | false |
false
| N/A | 0 | 9999999.999 | 10 | 3 | | |
CoolingMaximum | Edm.Decimal | true | false |
false
| N/A | 0 | 9999999.999 | 10 | 3 | | |
CoolingThreshold | Edm.Decimal | true | false |
false
| N/A | 0 | 9999999.999 | 10 | 3 | | |
HeatLimit | Edm.Decimal | true | false |
false
| N/A | 0 | 9999999.999 | 10 | 3 | | |
HeatMaximum | Edm.Decimal | true | false |
false
| N/A | 0 | 9999999.999 | 10 | 3 | | |
HeatThreshold | Edm.Decimal | true | false |
false
| N/A | 0 | 9999999.999 | 10 | 3 | | |
ID | Edm.Int32 | false | false |
true
| N/A | N/A | N/A | N/A | N/A | | |
Length | Edm.Decimal | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
LocationGroupID | Edm.Int32 | true | false |
true
| N/A | N/A | N/A | N/A | N/A | | Foreign key identifying the location |
NominalPower | Edm.Decimal | true | false |
false
| N/A | 0 | 9999999.999 | 10 | 3 | | |
SaveAction | Nlyte.Model.SaveActionEnum | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
WeightLimit | Edm.Decimal | true | false |
false
| N/A | 0 | 9999999.9999 | 11 | 4 | | |
WeightMaximum | Edm.Decimal | true | false |
false
| N/A | 0 | 9999999.9999 | 11 | 4 | | |
WeightThreshold | Edm.Decimal | true | false |
false
| N/A | 0 | 9999999.9999 | 11 | 4 | | |
Width | Edm.Decimal | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
Floor Navigational Properties
Verb(s) | Required Permission(s) | Link | Description |
---|
Get | WS-ReadFloorPlan | | |
Patch | WS-ModifyFloorPlan | | |
Put | WS-ModifyFloorPlan | | |
Post | WS-ModifyFloorPlan | | |
FloorLayer Structural Properties
Property | Type | Nullable | Mandatory | Read-Only | String length | Min Value | Max Value | Precision | Max Dec Places | Is Only Date | Description |
---|
FloorId | Edm.Int32 | true | false |
true
| N/A | N/A | N/A | N/A | N/A | | |
FloorLayer Navigational Properties
Verb(s) | Required Permission(s) | Link | Description |
---|
Get | WS-ReadAuxiliaryMaterial | integration/api/odata/FlywheelGeneratorAuxiliaryMaterials, integration/api/odata/FlywheelGeneratorAuxiliaryMaterials({key}) | |
Post | WS-AddAuxiliaryMaterial | integration/api/odata/FlywheelGeneratorAuxiliaryMaterials | |
PostWithKey | WS-ModifyAuxiliaryMaterial | | |
Patch | WS-ModifyAuxiliaryMaterial | integration/api/odata/FlywheelGeneratorAuxiliaryMaterials({key}) | |
Delete | WS-ModifyAuxiliaryMaterial | integration/api/odata/FlywheelGeneratorAuxiliaryMaterials({key}) | |
FlywheelGeneratorAuxiliaryMaterial Structural Properties
No structural properties
FlywheelGeneratorAuxiliaryMaterial Navigational Properties
No navigational properties
Verb(s) | Required Permission(s) | Link | Description |
---|
Get | WS-ReadForm | integration/api/odata/Forms, integration/api/odata/Forms({key}) | |
Post | WS-AddForm | integration/api/odata/Forms | |
Patch | WS-ModifyForm | integration/api/odata/Forms({key}) | |
Put | WS-ModifyForm | integration/api/odata/Forms({key}) | |
Form Structural Properties
Property | Type | Nullable | Mandatory | Read-Only | String length | Min Value | Max Value | Precision | Max Dec Places | Is Only Date | Description |
---|
DateCreated | Edm.DateTimeOffset | false | false |
true
| N/A | N/A | N/A | N/A | N/A | | |
DateLastUpdated | Edm.DateTimeOffset | false | false |
true
| N/A | N/A | N/A | N/A | N/A | | |
Description | Edm.String | true | false |
false
| 1000 | N/A | N/A | N/A | N/A | | |
DesignedByResourceID | Edm.Int32 | true | false |
true
| N/A | N/A | N/A | N/A | N/A | | |
FormStatusID | Nlyte.Model.FormStatus | false | true |
false
| N/A | N/A | N/A | N/A | N/A | | |
HasCascadingForms | Edm.Boolean | false | false |
true
| N/A | N/A | N/A | N/A | N/A | | |
ID | Edm.Int32 | false | false |
true
| N/A | N/A | N/A | N/A | N/A | | |
IsHidden | Edm.Boolean | false | false |
true
| N/A | N/A | N/A | N/A | N/A | | |
IsLatestVersion | Edm.Boolean | false | false |
true
| N/A | N/A | N/A | N/A | N/A | | |
LastUpdatedByResourceID | Edm.Int32 | true | false |
true
| N/A | N/A | N/A | N/A | N/A | | |
Name | Edm.String | false | true |
false
| 250 | N/A | N/A | N/A | N/A | | |
RootFormID | Edm.Int32 | true | false |
true
| N/A | N/A | N/A | N/A | N/A | | |
SequenceNumber | Edm.Int32 | false | false |
true
| N/A | N/A | N/A | N/A | N/A | | |
Version | Edm.Int32 | false | false |
true
| N/A | N/A | N/A | N/A | N/A | | |
Form Navigational Properties
Verb(s) | Required Permission(s) | Link | Description |
---|
Key(s) |
---|
FormBuilderMetaDataListID |
FormBuilderMetaDataList Structural Properties
Property | Type | Nullable | Mandatory | Read-Only | String length | Min Value | Max Value | Precision | Max Dec Places | Is Only Date | Description |
---|
DataFieldID | Edm.Int32 | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
DataFieldName | Edm.String | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
Description | Edm.String | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
FormBuilderMetaDataListID | Edm.Int32 | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
ItemOrder | Edm.Int32 | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
Name | Edm.String | false | true |
false
| N/A | N/A | N/A | N/A | N/A | | |
FormBuilderMetaDataList Navigational Properties
No navigational properties
Verb(s) | Required Permission(s) | Link | Description |
---|
FormControl Structural Properties
Property | Type | Nullable | Mandatory | Read-Only | String length | Min Value | Max Value | Precision | Max Dec Places | Is Only Date | Description |
---|
ColumnPosition | Edm.Int32 | false | true |
false
| N/A | N/A | N/A | N/A | N/A | | |
ControlTypeID | Nlyte.Model.FormControlType | false | false |
true
| N/A | N/A | N/A | N/A | N/A | | |
DependencyFormControlID | Edm.Int32 | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
DependencyFormControlTypeID | Nlyte.Model.DependencyType | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
DependencyFormControlValue | Edm.String | true | false |
false
| 2147483647 | N/A | N/A | N/A | N/A | | |
FormID | Edm.Int32 | true | false |
true
| N/A | N/A | N/A | N/A | N/A | | |
ID | Edm.Int32 | false | true |
false
| N/A | N/A | N/A | N/A | N/A | | |
IsRequired | Edm.Boolean | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
Label | Edm.String | true | false |
false
| 250 | N/A | N/A | N/A | N/A | | |
ParentFormControlID | Edm.Int32 | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
RequiredInEmail | Edm.Boolean | false | true |
false
| N/A | N/A | N/A | N/A | N/A | | |
RowPosition | Edm.Int32 | false | true |
false
| N/A | N/A | N/A | N/A | N/A | | |
ToolTip | Edm.String | true | false |
false
| 250 | N/A | N/A | N/A | N/A | | |
FormControl Navigational Properties
Verb(s) | Required Permission(s) | Link | Description |
---|
FormControlReportingTag Structural Properties
Property | Type | Nullable | Mandatory | Read-Only | String length | Min Value | Max Value | Precision | Max Dec Places | Is Only Date | Description |
---|
ID | Edm.Int32 | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
ReportingTagID | Edm.Int32 | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
FormControlReportingTag Navigational Properties
Verb(s) | Required Permission(s) | Link | Description |
---|
FormInstanceControlValue Structural Properties
Property | Type | Nullable | Mandatory | Read-Only | String length | Min Value | Max Value | Precision | Max Dec Places | Is Only Date | Description |
---|
ControlTypeID | Nlyte.Model.FormControlType | false | false |
true
| N/A | N/A | N/A | N/A | N/A | | |
ControlValue | Nlyte.Model.ControlValueSummary | false | true |
false
| N/A | N/A | N/A | N/A | N/A | | |
FormControlID | Edm.Int32 | true | true |
false
| N/A | N/A | N/A | N/A | N/A | | |
FormID | Edm.Int32 | true | true |
false
| N/A | N/A | N/A | N/A | N/A | | |
FormInstanceID | Edm.Int32 | false | true |
false
| N/A | N/A | N/A | N/A | N/A | | |
ID | Edm.Int32 | false | true |
false
| N/A | N/A | N/A | N/A | N/A | | |
RootFormInstanceID | Edm.Int32 | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
FormInstanceControlValue Navigational Properties
Verb(s) | Required Permission(s) | Link | Description |
---|
FunctionalUse Structural Properties
Property | Type | Nullable | Mandatory | Read-Only | String length | Min Value | Max Value | Precision | Max Dec Places | Is Only Date | Description |
---|
Detail | Edm.String | false | true |
false
| 50 | N/A | N/A | N/A | N/A | | Functional use description |
FunctionalUseID | Edm.Int32 | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
FunctionalUse Navigational Properties
No navigational properties
Verb(s) | Required Permission(s) | Link | Description |
---|
Get | WS-ReadAssetToAssetMapping | integration/api/odata/Graphs, integration/api/odata/Graphs({key}) | |
Post | WS-AddAssetToAssetMapping | | |
PostWithKey | WS-ModifyAssetToAssetMapping | | |
Patch | WS-ModifyAssetToAssetMapping | | |
Delete | WS-ModifyAssetToAssetMapping | | |
Graph Structural Properties
Property | Type | Nullable | Mandatory | Read-Only | String length | Min Value | Max Value | Precision | Max Dec Places | Is Only Date | Description |
---|
CableType | Edm.String | true | false |
false
| 10 | N/A | N/A | N/A | N/A | | |
ConnectionColor | Edm.Int32 | true | |
false
| | | | | | | |
ConnectionLength | Edm.Decimal | true | |
false
| | | | | | | |
ConnectionName | Edm.String | true | |
false
| | | | | | | |
CrossSectionalAreaID | Edm.Int32 | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
GraphID | Edm.Int32 | false | false |
true
| N/A | N/A | N/A | N/A | N/A | | Primary key, identifying uniquely a power connection. |
InputAssetID | Edm.Int32 | true | false |
true
| N/A | N/A | N/A | N/A | N/A | | |
InputConnectorID | Edm.Int32 | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | Foreign key for the entity representing the input plug used for the connection |
MaxKVA | Edm.Decimal | true | false |
false
| N/A | 0 | 99999999.9999 | 12 | 4 | | The max KVA value provided by the user when creating a power connection |
OutputAssetID | Edm.Int32 | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
OutputConnectorID | Edm.Int32 | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
Graph Navigational Properties
Verb(s) | Required Permission(s) | Link | Description |
---|
Get | WS-ReadRoomPlan | | |
Patch | WS-ModifyRoomPlan,WS-ModifyCabinet,WS-ModifyServer,WS-ModifyUPS,WS-ModifyNetwork,WS-ModifyPeripheral,WS-ModifyStaticSwitch,WS-ModifyReceptacle,WS-ModifyKVMSwitch,WS-ModifyAuxiliary,WS-ModifyAirConditioning,WS-ModifyChassis,WS-ModifyPDU,WS-ModifyPowerStrip | | |
Put | WS-ModifyRoomPlan,WS-ModifyCabinet,WS-ModifyServer,WS-ModifyUPS,WS-ModifyNetwork,WS-ModifyPeripheral,WS-ModifyStaticSwitch,WS-ModifyReceptacle,WS-ModifyKVMSwitch,WS-ModifyAuxiliary,WS-ModifyAirConditioning,WS-ModifyChassis,WS-ModifyPDU,WS-ModifyPowerStrip | | |
Grid Structural Properties
Property | Type | Nullable | Mandatory | Read-Only | String length | Min Value | Max Value | Precision | Max Dec Places | Is Only Date | Description |
---|
ColumnCount | Edm.Int32 | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
ColumnSize | Edm.Decimal | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
ID | Edm.Int32 | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
IsVisible | Edm.Boolean | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
OffsetX | Edm.Decimal | false | false |
false
| N/A | -9999999.999 | 9999999.999 | 10 | 3 | | |
OffsetY | Edm.Decimal | false | false |
false
| N/A | -9999999.999 | 9999999.999 | 10 | 3 | | |
PolygonID | Edm.Int32 | true | false |
true
| N/A | N/A | N/A | N/A | N/A | | |
RowCount | Edm.Int32 | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
RowSize | Edm.Decimal | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
SaveAction | Nlyte.Model.SaveActionEnum | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
Grid Navigational Properties
Verb(s) | Required Permission(s) | Link | Description |
---|
Get | WS-ReadFloorPlannerGridLabel | | |
Patch | WS-ModifyFloorPlannerGridLabel,WS-ModifyCabinet,WS-ModifyServer,WS-ModifyUPS,WS-ModifyNetwork,WS-ModifyPeripheral,WS-ModifyStaticSwitch,WS-ModifyReceptacle,WS-ModifyKVMSwitch,WS-ModifyAuxiliary,WS-ModifyAirConditioning,WS-ModifyChassis,WS-ModifyPDU,WS-ModifyPowerStrip | | |
Put | WS-ModifyFloorPlannerGridLabel,WS-ModifyCabinet,WS-ModifyServer,WS-ModifyUPS,WS-ModifyNetwork,WS-ModifyPeripheral,WS-ModifyStaticSwitch,WS-ModifyReceptacle,WS-ModifyKVMSwitch,WS-ModifyAuxiliary,WS-ModifyAirConditioning,WS-ModifyChassis,WS-ModifyPDU,WS-ModifyPowerStrip | | |
GridLabel Structural Properties
Property | Type | Nullable | Mandatory | Read-Only | String length | Min Value | Max Value | Precision | Max Dec Places | Is Only Date | Description |
---|
GridID | Edm.Int32 | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
ID | Edm.Int32 | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
PositionIndex | Edm.Int32 | false | false |
true
| N/A | N/A | N/A | N/A | N/A | | |
PositionOnGrid | Edm.Int32 | false | false |
true
| N/A | N/A | N/A | N/A | N/A | | |
SaveAction | Nlyte.Model.SaveActionEnum | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
Text | Edm.String | true | true |
false
| 10 | N/A | N/A | N/A | N/A | | |
GridLabel Navigational Properties
Verb(s) | Required Permission(s) | Link | Description |
---|
Get | WS-ReadBusinessGroup,WS-ReadSupportGroup | integration/api/odata/Groups({key}), integration/api/odata/Groups, integration/api/odata/Groups({key}) | |
Group Structural Properties
Property | Type | Nullable | Mandatory | Read-Only | String length | Min Value | Max Value | Precision | Max Dec Places | Is Only Date | Description |
---|
Description | Edm.String | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
EmailAddress | Edm.String | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
GroupID | Edm.Int32 | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
GroupName | Edm.String | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
GroupNumber | Edm.Int32 | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
GroupType | Nlyte.Model.GroupType | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | Group type: support group or business group |
ID | Edm.Int64 | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
RecordStatus | Nlyte.Model.OrganisationGroupRecordStatus | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | Reflects the real status of the group as is in the data-center Canceled or Active. |
TelephoneNumber | Edm.String | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
Group Navigational Properties
No navigational properties
Verb(s) | Required Permission(s) | Link | Description |
---|
Get | WS-ReadFile | | |
Delete | WS-ModifyFile | | |
HostFile Structural Properties
No structural properties
HostFile Navigational Properties
No navigational properties
Verb(s) | Required Permission(s) | Link | Description |
---|
HostMapping Structural Properties
Property | Type | Nullable | Mandatory | Read-Only | String length | Min Value | Max Value | Precision | Max Dec Places | Is Only Date | Description |
---|
Created | Edm.DateTimeOffset | false | false |
false
| N/A | N/A | N/A | N/A | N/A | IsOnlyDate | |
Discovered | Edm.DateTimeOffset | true | false |
false
| N/A | N/A | N/A | N/A | N/A | IsOnlyDate | |
ExternalID | Edm.String | true | false |
false
| 512 | N/A | N/A | N/A | N/A | | |
ExternalName | Edm.String | true | false |
false
| 70 | N/A | N/A | N/A | N/A | | |
HostMapID | Edm.Int32 | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
HostNumber | Edm.Int32 | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
LastUpdated | Edm.DateTimeOffset | false | false |
false
| N/A | N/A | N/A | N/A | N/A | IsOnlyDate | |
ProviderID | Edm.Guid | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
ServerHostID | Edm.Int32 | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
URL | Edm.String | true | false |
false
| 2048 | N/A | N/A | N/A | N/A | | |
HostMapping Navigational Properties
Verb(s) | Required Permission(s) | Link | Description |
---|
Post | WS-AddNote | | |
Patch | WS-ModifyNote | | |
Delete | WS-ModifyNote | | |
Get | WS-ReadNote | | |
HostNote Structural Properties
No structural properties
HostNote Navigational Properties
No navigational properties
Verb(s) | Required Permission(s) | Link | Description |
---|
ImportedProcessResult Structural Properties
Property | Type | Nullable | Mandatory | Read-Only | String length | Min Value | Max Value | Precision | Max Dec Places | Is Only Date | Description |
---|
ID | Edm.Int32 | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
Warnings | Collection(Edm.String) | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
ImportedProcessResult Navigational Properties
Verb(s) | Required Permission(s) | Link | Description |
---|
InputConnector Structural Properties
Property | Type | Nullable | Mandatory | Read-Only | String length | Min Value | Max Value | Precision | Max Dec Places | Is Only Date | Description |
---|
AssetID | Edm.Int32 | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | The asset ID of the Input Asset |
InputConnectorID | Edm.Int32 | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | Primary key |
InputConnectorMaterialID | Edm.Int32 | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | Input plug material, associated to the material from which the above AssetID was created from. |
Priority | Edm.Int32 | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | Plug priority defined on the material level |
InputConnector Navigational Properties
Verb(s) | Required Permission(s) | Link | Description |
---|
Key(s) |
---|
InputConnectorMaterialID |
InputConnectorMaterial Structural Properties
Property | Type | Nullable | Mandatory | Read-Only | String length | Min Value | Max Value | Precision | Max Dec Places | Is Only Date | Description |
---|
InputConnectorMaterialID | Edm.Int32 | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | Primary key |
InputConnectorTypeID | Edm.Int32 | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | The ID of one of the predefined input connector types. |
MaterialID | Edm.Int32 | true | false |
true
| N/A | N/A | N/A | N/A | N/A | | The parent material, holding the plug |
Position | Edm.Int32 | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | Plug position, read-only information |
Priority | Edm.Int32 | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | Plug priority defined on the material level |
InputConnectorMaterial Navigational Properties
Verb(s) | Required Permission(s) | Link | Description |
---|
Key(s) |
---|
InputConnectorTypeID |
InputConnectorType Structural Properties
Property | Type | Nullable | Mandatory | Read-Only | String length | Min Value | Max Value | Precision | Max Dec Places | Is Only Date | Description |
---|
InputConnectorTypeID | Edm.Int32 | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
Name | Edm.String | false | true |
false
| 50 | N/A | N/A | N/A | N/A | | |
InputConnectorType Navigational Properties
No navigational properties
Verb(s) | Required Permission(s) | Link | Description |
---|
IntegrationActivityParameter Structural Properties
Property | Type | Nullable | Mandatory | Read-Only | String length | Min Value | Max Value | Precision | Max Dec Places | Is Only Date | Description |
---|
Active | Edm.Boolean | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
BaseParameterID | Edm.Int32 | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
CreatedDate | Edm.DateTimeOffset | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
DataType | Edm.String | false | true |
false
| 200 | N/A | N/A | N/A | N/A | | |
Description | Edm.String | true | false |
false
| 1000 | N/A | N/A | N/A | N/A | | |
DirectionID | Edm.Int32 | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
DisplayAsList | Edm.Boolean | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
ID | Edm.Int32 | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
IntegrationActivityID | Edm.Int32 | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
LastUpdatedDate | Edm.DateTimeOffset | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
Length | Edm.Int32 | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
Name | Edm.String | false | true |
false
| 250 | N/A | N/A | N/A | N/A | | |
Required | Edm.Boolean | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
UserFriendlyName | Edm.String | true | false |
false
| 150 | N/A | N/A | N/A | N/A | | |
IntegrationActivityParameter Navigational Properties
Verb(s) | Required Permission(s) | Link | Description |
---|
IntegrationActivityParameterValueItem Structural Properties
Property | Type | Nullable | Mandatory | Read-Only | String length | Min Value | Max Value | Precision | Max Dec Places | Is Only Date | Description |
---|
Active | Edm.Boolean | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
ID | Edm.Int32 | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
IntegrationActivityParameterID | Edm.Int32 | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
ParentID | Edm.Int32 | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
Properties | Edm.String | false | true |
false
| N/A | N/A | N/A | N/A | N/A | | |
Text | Edm.String | false | true |
false
| 500 | N/A | N/A | N/A | N/A | | |
IntegrationActivityParameterValueItem Navigational Properties
Verb(s) | Required Permission(s) | Link | Description |
---|
Get | WS-ReadProcess | integration/api/odata/IntegrationSystems, integration/api/odata/IntegrationSystems({key}) | |
IntegrationSystem Structural Properties
Property | Type | Nullable | Mandatory | Read-Only | String length | Min Value | Max Value | Precision | Max Dec Places | Is Only Date | Description |
---|
Active | Edm.Boolean | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
CreatedDate | Edm.DateTimeOffset | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
Description | Edm.String | true | false |
false
| 1000 | N/A | N/A | N/A | N/A | | |
EndSystemVersion | Edm.String | true | false |
false
| 75 | N/A | N/A | N/A | N/A | | |
Guid | Edm.Guid | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
ID | Edm.Int32 | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
LastUpdatedDate | Edm.DateTimeOffset | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
Name | Edm.String | false | true |
false
| 250 | N/A | N/A | N/A | N/A | | |
PluginVersion | Edm.String | false | true |
false
| 75 | N/A | N/A | N/A | N/A | | |
UserFriendlyName | Edm.String | true | false |
false
| 150 | N/A | N/A | N/A | N/A | | |
IntegrationSystem Navigational Properties
Verb(s) | Required Permission(s) | Link | Description |
---|
IntegrationSystemActivity Structural Properties
Property | Type | Nullable | Mandatory | Read-Only | String length | Min Value | Max Value | Precision | Max Dec Places | Is Only Date | Description |
---|
Active | Edm.Boolean | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
CreatedDate | Edm.DateTimeOffset | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
Description | Edm.String | true | false |
false
| 1000 | N/A | N/A | N/A | N/A | | |
ID | Edm.Int32 | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
IntegrationSystemID | Edm.Int32 | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
LastUpdatedDate | Edm.DateTimeOffset | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
Name | Edm.String | false | true |
false
| 250 | N/A | N/A | N/A | N/A | | |
OnErrorActionID | Edm.Int32 | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
ServiceName | Edm.String | false | true |
false
| 250 | N/A | N/A | N/A | N/A | | |
TypeID | Edm.Int32 | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
UserFriendlyName | Edm.String | true | false |
false
| 150 | N/A | N/A | N/A | N/A | | |
IntegrationSystemActivity Navigational Properties
Verb(s) | Required Permission(s) | Link | Description |
---|
IntegrationSystemActivityType Structural Properties
Property | Type | Nullable | Mandatory | Read-Only | String length | Min Value | Max Value | Precision | Max Dec Places | Is Only Date | Description |
---|
Description | Edm.String | false | true |
false
| 50 | N/A | N/A | N/A | N/A | | |
ID | Edm.Int32 | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
IntegrationSystemActivityType Navigational Properties
No navigational properties
Verb(s) | Required Permission(s) | Link | Description |
---|
Get | WS-ReadInternalEquipmentItem | integration/api/odata/InternalEquipmentCategories, integration/api/odata/InternalEquipmentCategories({key}) | |
Patch | WS-ModifyInternalEquipmentItem | | |
Delete | WS-ModifyInternalEquipmentItem | | |
Post | WS-AddInternalEquipmentItem | | |
InternalEquipmentCategory Structural Properties
Property | Type | Nullable | Mandatory | Read-Only | String length | Min Value | Max Value | Precision | Max Dec Places | Is Only Date | Description |
---|
CategoryID | Edm.Int32 | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
CategoryName | Edm.String | false | true |
false
| 15 | N/A | N/A | N/A | N/A | | |
Unit | Edm.String | false | true |
false
| 15 | N/A | N/A | N/A | N/A | | |
InternalEquipmentCategory Navigational Properties
Verb(s) | Required Permission(s) | Link | Description |
---|
Get | WS-ReadInternalEquipmentItem | | |
Patch | WS-ModifyInternalEquipmentItem | | |
Delete | WS-ModifyInternalEquipmentItem | | |
Post | WS-AddInternalEquipmentItem | | |
InternalEquipmentCategorySize Structural Properties
Property | Type | Nullable | Mandatory | Read-Only | String length | Min Value | Max Value | Precision | Max Dec Places | Is Only Date | Description |
---|
CategoryID | Edm.Int32 | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | The category that holds the current internal equipment category size. |
CategorySizeID | Edm.Int32 | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
Size | Edm.String | true | false |
false
| 50 | N/A | N/A | N/A | N/A | | |
InternalEquipmentCategorySize Navigational Properties
Verb(s) | Required Permission(s) | Link | Description |
---|
Get | WS-ReadInternalEquipmentItem | integration/api/odata/InternalEquipmentItems, integration/api/odata/InternalEquipmentItems({key}) | |
Patch | WS-ModifyInternalEquipmentItem | integration/api/odata/InternalEquipmentItems({key}) | |
Delete | WS-ModifyInternalEquipmentItem | integration/api/odata/InternalEquipmentItems({key}) | |
PostWithKey | WS-ModifyInternalEquipmentItem | | |
Post | WS-AddInternalEquipmentItem | integration/api/odata/InternalEquipmentItems | |
InternalEquipmentItem Structural Properties
Property | Type | Nullable | Mandatory | Read-Only | String length | Min Value | Max Value | Precision | Max Dec Places | Is Only Date | Description |
---|
CategorySizeID | Edm.Int32 | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | Value defined in the administration area |
EntityID | Edm.Int32 | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | The asset for which the equipment is defined. |
ItemCount | Edm.Int32 | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
ItemID | Edm.Int32 | false | false |
true
| N/A | N/A | N/A | N/A | N/A | | The selected equipment item id. |
ItemName | Edm.String | true | true |
false
| 30 | N/A | N/A | N/A | N/A | | |
ItemReference | Edm.Int32 | true | false |
true
| N/A | N/A | N/A | N/A | N/A | | |
InternalEquipmentItem Navigational Properties
Verb(s) | Required Permission(s) | Link | Description |
---|
Post | WS-AddNote | | |
Patch | WS-ModifyNote | | |
Delete | WS-ModifyNote | | |
Get | WS-ReadNote | | |
InternalEquipmentItemNote Structural Properties
No structural properties
InternalEquipmentItemNote Navigational Properties
No navigational properties
Verb(s) | Required Permission(s) | Link | Description |
---|
Get | WS-ReadInternalEquipmentItemUtilisation | integration/api/odata/InternalEquipmentItemUtilisations, integration/api/odata/InternalEquipmentItemUtilisations({key}) | |
Patch | WS-ModifyInternalEquipmentItemUtilisation | integration/api/odata/InternalEquipmentItemUtilisations({key}) | |
Delete | WS-ModifyInternalEquipmentItemUtilisation | integration/api/odata/InternalEquipmentItemUtilisations({key}) | |
Post | WS-AddInternalEquipmentItemUtilisation | integration/api/odata/InternalEquipmentItemUtilisations | |
InternalEquipmentItemUtilisation Structural Properties
Property | Type | Nullable | Mandatory | Read-Only | String length | Min Value | Max Value | Precision | Max Dec Places | Is Only Date | Description |
---|
ItemID | Edm.Int32 | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
ItemUtilisationID | Edm.Int32 | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
PhysicalPartitionID | Edm.Int32 | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
PhysicalPartitionUtilisationPercentage | Edm.Int32 | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
ServerHostID | Edm.Int32 | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
ServerHostUtilisationPercentage | Edm.Int32 | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | Entity representing the relation between the an entity and equipment defined in the administration area. |
InternalEquipmentItemUtilisation Navigational Properties
Verb(s) | Required Permission(s) | Link | Description |
---|
Post | WS-AddNote | | |
Patch | WS-ModifyNote | | |
Delete | WS-ModifyNote | | |
Get | WS-ReadNote | | |
InternalEquipmentItemUtilizationNote Structural Properties
No structural properties
InternalEquipmentItemUtilizationNote Navigational Properties
No navigational properties
Verb(s) | Required Permission(s) | Link | Description |
---|
IPAddress Structural Properties
Property | Type | Nullable | Mandatory | Read-Only | String length | Min Value | Max Value | Precision | Max Dec Places | Is Only Date | Description |
---|
IP | Edm.String | true | false |
true
| N/A | N/A | N/A | N/A | N/A | | |
IPAddressID | Edm.Int32 | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
IPCIDR | Edm.Byte | false | true |
false
| N/A | N/A | N/A | N/A | N/A | | |
IPOctetA | Edm.Byte | false | true |
false
| N/A | N/A | N/A | N/A | N/A | | |
IPOctetB | Edm.Byte | false | true |
false
| N/A | N/A | N/A | N/A | N/A | | |
IPOctetC | Edm.Byte | false | true |
false
| N/A | N/A | N/A | N/A | N/A | | |
IPOctetD | Edm.Byte | false | true |
false
| N/A | N/A | N/A | N/A | N/A | | |
IPUsageID | Edm.Int32 | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | Usage defined in the administration area. |
Subnet | Edm.String | true | false |
true
| N/A | N/A | N/A | N/A | N/A | | |
SubnetOctetA | Edm.Byte | false | false |
true
| N/A | N/A | N/A | N/A | N/A | | |
SubnetOctetB | Edm.Byte | false | false |
true
| N/A | N/A | N/A | N/A | N/A | | |
SubnetOctetC | Edm.Byte | false | false |
true
| N/A | N/A | N/A | N/A | N/A | | |
SubnetOctetD | Edm.Byte | false | false |
true
| N/A | N/A | N/A | N/A | N/A | | |
IPAddress Navigational Properties
Verb(s) | Required Permission(s) | Link | Description |
---|
Post | WS-AddNote | | |
Patch | WS-ModifyNote | | |
Delete | WS-ModifyNote | | |
Get | WS-ReadNote | | |
IPAddressNetworkDependencyNote Structural Properties
No structural properties
IPAddressNetworkDependencyNote Navigational Properties
No navigational properties
Verb(s) | Required Permission(s) | Link | Description |
---|
IPUsage Structural Properties
Property | Type | Nullable | Mandatory | Read-Only | String length | Min Value | Max Value | Precision | Max Dec Places | Is Only Date | Description |
---|
Detail | Edm.String | false | true |
false
| 40 | N/A | N/A | N/A | N/A | | IP Usage |
IPUsageID | Edm.Int32 | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
IPUsage Navigational Properties
No navigational properties
Verb(s) | Required Permission(s) | Link | Description |
---|
Issue Structural Properties
Property | Type | Nullable | Mandatory | Read-Only | String length | Min Value | Max Value | Precision | Max Dec Places | Is Only Date | Description |
---|
Body | Edm.String | false | true |
false
| 800 | N/A | N/A | N/A | N/A | | |
DateCreated | Edm.DateTimeOffset | false | false |
true
| N/A | N/A | N/A | N/A | N/A | IsOnlyDate | |
DateResolved | Edm.DateTimeOffset | true | false |
true
| N/A | N/A | N/A | N/A | N/A | IsOnlyDate | |
EntityID | Edm.Int32 | true | false |
true
| N/A | N/A | N/A | N/A | N/A | | |
ExpectedResolutionDate | Edm.DateTimeOffset | true | false |
false
| N/A | N/A | N/A | N/A | N/A | IsOnlyDate | |
ID | Edm.Int32 | false | false |
true
| N/A | N/A | N/A | N/A | N/A | | |
ResourceID | Edm.Int32 | true | false |
true
| N/A | N/A | N/A | N/A | N/A | | |
Subject | Edm.String | false | true |
false
| 100 | N/A | N/A | N/A | N/A | | |
TypeID | Nlyte.Model.IssueTypeWf | false | true |
false
| N/A | N/A | N/A | N/A | N/A | | |
Issue Navigational Properties
Verb(s) | Required Permission(s) | Link | Description |
---|
Get | WS-ReadPeripheralMaterial | integration/api/odata/KeyboardPeripheralMaterials, integration/api/odata/KeyboardPeripheralMaterials({key}) | |
Post | WS-AddPeripheralMaterial | integration/api/odata/KeyboardPeripheralMaterials | |
PostWithKey | WS-ModifyPeripheralMaterial | | |
Patch | WS-ModifyPeripheralMaterial | integration/api/odata/KeyboardPeripheralMaterials({key}) | |
Delete | WS-ModifyPeripheralMaterial | integration/api/odata/KeyboardPeripheralMaterials({key}) | |
KeyboardPeripheralMaterial Structural Properties
No structural properties
KeyboardPeripheralMaterial Navigational Properties
No navigational properties
KVMSwitch Entity
: Asset
- Asset created from a material of type KVM Switch, entity inheriting the Nlyte.Model.Asset entity
Verb(s) | Required Permission(s) | Link | Description |
---|
Get | WS-ReadKVMSwitch | integration/api/odata/KVMSwitches, integration/api/odata/KVMSwitches({key}) | |
Patch | WS-ModifyKVMSwitch | integration/api/odata/KVMSwitches({key}) | |
Delete | WS-ModifyKVMSwitch | integration/api/odata/KVMSwitches({key}) | |
PostWithKey | WS-ModifyKVMSwitch | integration/api/odata/KVMSwitches({key}) | |
Post | WS-AddKVMSwitch | integration/api/odata/KVMSwitches | |
KVMSwitch Structural Properties
Property | Type | Nullable | Mandatory | Read-Only | String length | Min Value | Max Value | Precision | Max Dec Places | Is Only Date | Description |
---|
AuditDate | Edm.DateTimeOffset | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
AuditStatusCorrect | Edm.Boolean | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
FreePorts | Edm.Int32 | false | false |
true
| N/A | N/A | N/A | N/A | N/A | | |
LastAuditorAccountID | Edm.Int32 | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
TotalPlugs | Edm.Int32 | false | false |
true
| N/A | N/A | N/A | N/A | N/A | | |
KVMSwitch Navigational Properties
Verb(s) | Required Permission(s) | Link | Description |
---|
Get | WS-ReadKVMSwitchCabinetMap | | |
Post | WS-AddKVMSwitchCabinetMap | | |
Patch | WS-ModifyKVMSwitchCabinetMap | | |
PostWithKey | WS-ModifyKVMSwitchCabinetMap | | |
Delete | WS-ModifyKVMSwitchCabinetMap | | |
Key(s) |
---|
KVMSwitchCabinetMapID |
KVMSwitchCabinetMap Structural Properties
Property | Type | Nullable | Mandatory | Read-Only | String length | Min Value | Max Value | Precision | Max Dec Places | Is Only Date | Description |
---|
CabinetAssetID | Edm.Int32 | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
KVMSwitchAssetID | Edm.Int32 | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
KVMSwitchCabinetMapID | Edm.Int32 | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
KVMSwitchCabinetMap Navigational Properties
Verb(s) | Required Permission(s) | Link | Description |
---|
Get | WS-ReadKVMSwitchMaterial | integration/api/odata/KVMSwitchMaterials, integration/api/odata/KVMSwitchMaterials({key}) | |
Post | WS-AddKVMSwitchMaterial | integration/api/odata/KVMSwitchMaterials | |
PostWithKey | WS-ModifyKVMSwitchMaterial | integration/api/odata/KVMSwitchMaterials({key}) | |
Patch | WS-ModifyKVMSwitchMaterial | integration/api/odata/KVMSwitchMaterials({key}) | |
Delete | WS-ModifyKVMSwitchMaterial | integration/api/odata/KVMSwitchMaterials({key}) | |
KVMSwitchMaterial Structural Properties
Property | Type | Nullable | Mandatory | Read-Only | String length | Min Value | Max Value | Precision | Max Dec Places | Is Only Date | Description |
---|
CalculatedMpafPowerConsumption | Edm.Decimal | true | false |
true
| N/A | N/A | N/A | N/A | N/A | | Read-only property, value provided by the service based on the PublishedPowerConsumption and the MpafOverride |
ConsumerPowerFactor | Edm.Decimal | false | false |
true
| N/A | N/A | N/A | N/A | N/A | | Read-only property representing the percentage of power drawn by a PDD material that is available to its asset consumers |
MaterialCategoryID | Edm.Int32 | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
MountingTypeID | Nlyte.Model.MountingTypeEnum | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
MpafOverride | Edm.Decimal | true | false |
false
| N/A | 0.001 | 999 | 6 | 3 | | Value inserted by the user, while the material is in Planned status |
NumberOfPorts | Edm.Int32 | false | true |
false
| N/A | N/A | N/A | N/A | N/A | | |
PowerTypeID | Nlyte.Model.PowerTypeEnum | false | true |
false
| N/A | N/A | N/A | N/A | N/A | | Power type: phased or direct current |
PublishedPowerConsumption | Edm.Decimal | false | false |
false
| N/A | 0.001 | 999 | 6 | 3 | | Value inserted by the user, while the material is in Planned status |
RequiredPlugs | Edm.Int32 | false | true |
false
| N/A | N/A | N/A | N/A | N/A | | Value inserted by the user, while the material is in Planned status |
RequiresDiversePower | Edm.Boolean | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | Value available to be updated by the user only if RequiredPlugs TotalPlugs |
TotalPlugs | Edm.Int32 | false | true |
false
| N/A | N/A | N/A | N/A | N/A | | Value inserted by the user, while the material is in Planned status |
UHeight | Edm.Int64 | false | false |
true
| N/A | N/A | N/A | N/A | N/A | | |
WorkableFootPrintFront | Edm.Double | false | false |
false
| N/A | 0 | 999999999999.9999 | 16 | 4 | | |
WorkableFootPrintHeight | Edm.Double | false | false |
false
| N/A | 0 | 999999999999.9999 | 16 | 4 | | |
WorkableFootPrintRear | Edm.Double | false | false |
false
| N/A | 0 | 999999999999.9999 | 16 | 4 | | |
KVMSwitchMaterial Navigational Properties
Verb(s) | Required Permission(s) | Link | Description |
---|
Get | WS-ReadKVMSwitchPortConsumerLink | | |
Post | WS-AddKVMSwitchPortConsumerLink | | |
PostWithKey | WS-ModifyKVMSwitchPortConsumerLink | | |
Patch | WS-ModifyKVMSwitchPortConsumerLink | | |
Delete | WS-ModifyKVMSwitchPortConsumerLink | | |
Key(s) |
---|
KVMSwitchPortConsumerLinkID |
KVMSwitchPortConsumerLink Structural Properties
Property | Type | Nullable | Mandatory | Read-Only | String length | Min Value | Max Value | Precision | Max Dec Places | Is Only Date | Description |
---|
KVMSwitchAssetID | Edm.Int32 | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
KVMSwitchPortConsumerLinkID | Edm.Int32 | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
PortConsumerAssetID | Edm.Int32 | true | true |
false
| N/A | N/A | N/A | N/A | N/A | | |
Position | Edm.Int32 | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
KVMSwitchPortConsumerLink Navigational Properties
Verb(s) | Required Permission(s) | Link | Description |
---|
LabelControl Structural Properties
No structural properties
LabelControl Navigational Properties
No navigational properties
Verb(s) | Required Permission(s) | Link | Description |
---|
LabelControlValue Structural Properties
No structural properties
LabelControlValue Navigational Properties
No navigational properties
Verb(s) | Required Permission(s) | Link | Description |
---|
Layer Structural Properties
Property | Type | Nullable | Mandatory | Read-Only | String length | Min Value | Max Value | Precision | Max Dec Places | Is Only Date | Description |
---|
ID | Edm.Int32 | false | true |
false
| N/A | N/A | N/A | N/A | N/A | | |
LayerTypeID | Nlyte.Model.LayerType | false | true |
true
| N/A | N/A | N/A | N/A | N/A | | |
LocationGroupID | Edm.Int32 | true | false |
true
| N/A | N/A | N/A | N/A | N/A | | Foreign key identifying the location |
Locked | Edm.Boolean | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
Name | Edm.String | true | true |
false
| 50 | N/A | N/A | N/A | N/A | | |
SaveAction | Nlyte.Model.SaveActionEnum | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
Visible | Edm.Boolean | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
ZOrder | Edm.Int32 | false | true |
false
| N/A | N/A | N/A | N/A | N/A | | |
Layer Navigational Properties
Verb(s) | Required Permission(s) | Link | Description |
---|
LayerImage Structural Properties
Property | Type | Nullable | Mandatory | Read-Only | String length | Min Value | Max Value | Precision | Max Dec Places | Is Only Date | Description |
---|
Image | Edm.Binary | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
ImageFileTypeID | Nlyte.Model.ImageFileType | false | true |
false
| N/A | N/A | N/A | N/A | N/A | | |
LayerID | Edm.Int32 | true | true |
false
| N/A | N/A | N/A | N/A | N/A | | |
Length | Edm.Decimal | false | true |
false
| N/A | 0 | 9999999999.99 | 12 | 2 | | |
Width | Edm.Decimal | false | true |
false
| N/A | 0 | 9999999999.99 | 12 | 2 | | |
LayerImage Navigational Properties
Verb(s) | Required Permission(s) | Link | Description |
---|
License Structural Properties
Property | Type | Nullable | Mandatory | Read-Only | String length | Min Value | Max Value | Precision | Max Dec Places | Is Only Date | Description |
---|
Company | Edm.String | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | The company for which the license was issued |
EditionID | Edm.String | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
EditionName | Edm.String | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
Error | Edm.String | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
IsEvaluation | Edm.Boolean | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
IsInitialised | Edm.Boolean | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
IsValid | Edm.Boolean | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | True is the license didn't expired. |
Modules | Collection(Nlyte.Model.Module) | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | A collection of licensed modules. |
License Navigational Properties
No navigational properties
Verb(s) | Required Permission(s) | Link | Description |
---|
ListItem Structural Properties
Property | Type | Nullable | Mandatory | Read-Only | String length | Min Value | Max Value | Precision | Max Dec Places | Is Only Date | Description |
---|
ID | Edm.Int64 | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
ItemID | Edm.Int32 | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
ListTypeID | Edm.Int32 | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
Name | Edm.String | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
ListItem Navigational Properties
Verb(s) | Required Permission(s) | Link | Description |
---|
ListType Structural Properties
Property | Type | Nullable | Mandatory | Read-Only | String length | Min Value | Max Value | Precision | Max Dec Places | Is Only Date | Description |
---|
Description | Edm.String | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
ListTypeID | Edm.Int32 | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
RecordTypeID | Edm.Int32 | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
ListType Navigational Properties
Verb(s) | Required Permission(s) | Link | Description |
---|
LocationGroup Structural Properties
Property | Type | Nullable | Mandatory | Read-Only | String length | Min Value | Max Value | Precision | Max Dec Places | Is Only Date | Description |
---|
AvailabilityMetric | Edm.Boolean | false | false |
true
| N/A | N/A | N/A | N/A | N/A | | |
CabinetUSpaceMetric | Edm.Boolean | false | false |
true
| N/A | N/A | N/A | N/A | N/A | | |
CloudProviderId | Edm.Int32 | true | false |
true
| N/A | N/A | N/A | N/A | N/A | | The selected cloud provider, from the available list defined in the administration area. |
Decommission | Edm.Boolean | false | false |
true
| N/A | N/A | N/A | N/A | N/A | | True is the location can be used for action planning for decommission action. |
DuplicateLocationGroupName | Edm.String | true | false |
true
| 260 | N/A | N/A | N/A | N/A | | The unique location name, having the name as a concatenation of last hierarchical location names. |
EnergyMeteringMetric | Edm.Boolean | false | false |
true
| N/A | N/A | N/A | N/A | N/A | | |
FacilityUtilizationMetric | Edm.Boolean | false | false |
true
| N/A | N/A | N/A | N/A | N/A | | |
HasChildren | Edm.Boolean | false | false |
true
| N/A | N/A | N/A | N/A | N/A | | True if the location acts as a parent for another location. |
HasFLoorPlannerRoom | Edm.Boolean | false | false |
true
| N/A | N/A | N/A | N/A | N/A | | |
IsAccessible | Edm.Boolean | false | false |
true
| N/A | N/A | N/A | N/A | N/A | | |
IsCloud | Edm.Boolean | false | false |
true
| N/A | N/A | N/A | N/A | N/A | | |
IsFloorViewable | Edm.Boolean | true | false |
true
| N/A | N/A | N/A | N/A | N/A | | True if the the floor has one or more rooms which are accessible |
Latitude | Edm.Decimal | true | false |
true
| N/A | N/A | N/A | N/A | N/A | | |
LocationAlias | Edm.String | true | false |
true
| 255 | N/A | N/A | N/A | N/A | | |
LocationGroupID | Edm.Int32 | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
LocationGroupName | Edm.String | true | false |
false
| 150 | N/A | N/A | N/A | N/A | | |
LocationGroupType | Nlyte.Model.LocationGroupTypeEnum | false | false |
true
| N/A | N/A | N/A | N/A | N/A | | |
LocationPurposeId | Edm.Int32 | true | false |
true
| N/A | N/A | N/A | N/A | N/A | | The selected purpose, from the available list defined in the administration area. |
LocationStatusId | Edm.Int32 | false | false |
true
| N/A | N/A | N/A | N/A | N/A | | |
LocationTierId | Edm.Int32 | true | false |
true
| N/A | N/A | N/A | N/A | N/A | | |
Longitude | Edm.Decimal | true | false |
true
| N/A | N/A | N/A | N/A | N/A | | |
Monitored | Edm.Boolean | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | If true, the room is added to NEO |
MonthlyCost | Edm.Decimal | true | false |
true
| N/A | 0 | 99999999999.99 | 13 | 2 | | |
Move | Edm.Boolean | false | false |
true
| N/A | N/A | N/A | N/A | N/A | | True is the location can be used for action planning for move action. |
ParentLocationGroupID | Edm.Int32 | true | false |
true
| N/A | N/A | N/A | N/A | N/A | | |
PUEMetric | Edm.Boolean | false | false |
true
| N/A | N/A | N/A | N/A | N/A | | |
Recycle | Edm.Boolean | false | false |
true
| N/A | N/A | N/A | N/A | N/A | | True is the location can be used for action planning for recycle action. |
ServerUtilizationMetric | Edm.Boolean | false | false |
true
| N/A | N/A | N/A | N/A | N/A | | |
Tag | Edm.String | true | false |
false
| 40 | N/A | N/A | N/A | N/A | | |
UnderutilizedServerMetric | Edm.Boolean | false | false |
true
| N/A | N/A | N/A | N/A | N/A | | |
VirtualizationMetric | Edm.Boolean | false | false |
true
| N/A | N/A | N/A | N/A | N/A | | |
ZipCode | Edm.String | true | false |
false
| 25 | N/A | N/A | N/A | N/A | | Postal / Zip Code for building locations. |
LocationGroup Navigational Properties
Verb(s) | Required Permission(s) | Link | Description |
---|
Post | WS-AddNote | | |
Patch | WS-ModifyNote | | |
Delete | WS-ModifyNote | | |
Get | WS-ReadNote | | |
LocationGroupNote Structural Properties
Property | Type | Nullable | Mandatory | Read-Only | String length | Min Value | Max Value | Precision | Max Dec Places | Is Only Date | Description |
---|
SaveAction | Nlyte.Model.SaveActionEnum | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
LocationGroupNote Navigational Properties
No navigational properties
Verb(s) | Required Permission(s) | Link | Description |
---|
LocationPurpose Structural Properties
Property | Type | Nullable | Mandatory | Read-Only | String length | Min Value | Max Value | Precision | Max Dec Places | Is Only Date | Description |
---|
Detail | Edm.String | false | true |
false
| 255 | N/A | N/A | N/A | N/A | | Location purpose description |
LocationPurposeId | Edm.Int32 | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
LocationPurpose Navigational Properties
No navigational properties
Verb(s) | Required Permission(s) | Link | Description |
---|
Key(s) |
---|
LogicalPartitionTypeID |
LogicalPartitionType Structural Properties
Property | Type | Nullable | Mandatory | Read-Only | String length | Min Value | Max Value | Precision | Max Dec Places | Is Only Date | Description |
---|
Detail | Edm.String | false | true |
false
| 40 | N/A | N/A | N/A | N/A | | |
LogicalPartitionTypeID | Edm.Int32 | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
LogicalPartitionType Navigational Properties
No navigational properties
Verb(s) | Required Permission(s) | Link | Description |
---|
Maintenance Structural Properties
Property | Type | Nullable | Mandatory | Read-Only | String length | Min Value | Max Value | Precision | Max Dec Places | Is Only Date | Description |
---|
AssetID | Edm.Int32 | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
Comments | Edm.String | true | false |
false
| 1000 | N/A | N/A | N/A | N/A | | |
ContractRef | Edm.String | true | false |
false
| 40 | N/A | N/A | N/A | N/A | | |
EndDate | Edm.DateTimeOffset | true | false |
false
| N/A | N/A | N/A | N/A | N/A | IsOnlyDate | |
LastDate | Edm.DateTimeOffset | true | false |
false
| N/A | N/A | N/A | N/A | N/A | IsOnlyDate | |
MaintenanceAnnualMaintenance | Edm.String | true | false |
false
| 40 | N/A | N/A | N/A | N/A | | |
MaintenanceCostCenter | Edm.String | true | false |
false
| 1000 | N/A | N/A | N/A | N/A | | |
MaintenanceDepreciation | Edm.String | true | false |
false
| 40 | N/A | N/A | N/A | N/A | | |
MaintenancePaymentSchedule | Edm.String | true | false |
false
| 1000 | N/A | N/A | N/A | N/A | | |
StartDate | Edm.DateTimeOffset | true | false |
false
| N/A | N/A | N/A | N/A | N/A | IsOnlyDate | |
Maintenance Navigational Properties
Verb(s) | Required Permission(s) | Link | Description |
---|
Manufacturer Structural Properties
Property | Type | Nullable | Mandatory | Read-Only | String length | Min Value | Max Value | Precision | Max Dec Places | Is Only Date | Description |
---|
Detail | Edm.String | false | true |
false
| 30 | N/A | N/A | N/A | N/A | | Manufacturer |
ManufacturerID | Edm.Int32 | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
Manufacturer Navigational Properties
No navigational properties
Verb(s) | Required Permission(s) | Link | Description |
---|
Get | WS-ReadRoomPlan | | |
Patch | WS-ModifyRoomPlan | | |
Put | WS-ModifyRoomPlan | | |
Delete | WS-ModifyRoomPlan | | |
Post | WS-ModifyRoomPlan | | |
Marker Structural Properties
Property | Type | Nullable | Mandatory | Read-Only | String length | Min Value | Max Value | Precision | Max Dec Places | Is Only Date | Description |
---|
DisplayName | Edm.Boolean | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
ID | Edm.Int32 | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
LayerID | Edm.Int32 | true | true |
false
| N/A | N/A | N/A | N/A | N/A | | |
Overlaps | Edm.Boolean | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
PolygonId | Edm.Int32 | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
PreventsItemAddition | Edm.Boolean | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
SaveAction | Nlyte.Model.SaveActionEnum | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
Marker Navigational Properties
Verb(s) | Required Permission(s) | Link | Description |
---|
Get | WS-ReadPDUBreaker | integration/api/odata/MasterBreakers, integration/api/odata/MasterBreakers({key}) | |
MasterBreaker Structural Properties
Property | Type | Nullable | Mandatory | Read-Only | String length | Min Value | Max Value | Precision | Max Dec Places | Is Only Date | Description |
---|
Child1BreakerID | Edm.Int32 | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | The key that identifies the first child breaker. |
Child1PhaseColour | Edm.String | true | false |
false
| 255 | N/A | N/A | N/A | N/A | | |
Child1PhaseColourIndex | Edm.Int32 | true | false |
true
| N/A | N/A | N/A | N/A | N/A | | |
Child1Position | Edm.Int32 | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
Child2BreakerID | Edm.Int32 | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | The key that identifies the second child breaker. |
Child2PhaseColour | Edm.String | true | false |
false
| 255 | N/A | N/A | N/A | N/A | | |
Child2PhaseColourIndex | Edm.Int32 | true | false |
true
| N/A | N/A | N/A | N/A | N/A | | |
Child2Position | Edm.Int32 | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
MasterBreaker Navigational Properties
No navigational properties
Verb(s) | Required Permission(s) | Link | Description |
---|
Get | WS-ReadAirConditioningMaterial,WS-ReadAuxiliaryMaterial,WS-ReadCabinetMaterial,WS-ReadChassisMaterial,WS-ReadKVMSwitchMaterial,WS-ReadNetworkMaterial,WS-ReadPDUMaterial,WS-ReadPeripheralMaterial,WS-ReadPowerStripMaterial,WS-ReadReceptacleMaterial,WS-ReadServerMaterial,WS-ReadStaticSwitchMaterial,WS-ReadUPSMaterial | integration/api/odata/Materials, integration/api/odata/Materials({key}) | |
Material Structural Properties
Property | Type | Nullable | Mandatory | Read-Only | String length | Min Value | Max Value | Precision | Max Dec Places | Is Only Date | Description |
---|
ExternalDepth | Edm.Double | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
ExternalHeight | Edm.Double | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
ExternalWidth | Edm.Double | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
IsEditable | Edm.Boolean | true | false |
true
| N/A | N/A | N/A | N/A | N/A | | False means that is nlyte supplied. |
ManufacturerID | Edm.Int32 | true | true |
false
| N/A | N/A | N/A | N/A | N/A | | The manufacturer ID, used from the predefined list of manufacturers. |
MaterialID | Edm.Int32 | false | false |
true
| N/A | N/A | N/A | N/A | N/A | | |
MaterialName | Edm.String | false | true |
false
| 100 | N/A | N/A | N/A | N/A | | Name of the Material. This needs to be unique in the system. |
MaterialNumber | Edm.Int32 | true | false |
true
| N/A | N/A | N/A | N/A | N/A | | |
MaterialTypeID | Edm.Int32 | true | false |
true
| N/A | N/A | N/A | N/A | N/A | | Material type foreign key |
Model | Edm.String | false | true |
false
| 255 | N/A | N/A | N/A | N/A | | |
RecordStatus | Nlyte.Model.MaterialRecordStatus | false | true |
false
| N/A | N/A | N/A | N/A | N/A | | Reflects the real status of the material as is in the data-center. |
Weight | Edm.Double | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
Material Navigational Properties
Verb(s) | Required Permission(s) | Link | Description |
---|
Get | WS-ReadAirConditioningMaterial,WS-ReadAuxiliaryMaterial,WS-ReadCabinetMaterial,WS-ReadChassisMaterial,WS-ReadKVMSwitchMaterial,WS-ReadNetworkMaterial,WS-ReadPDUMaterial,WS-ReadPeripheralMaterial,WS-ReadPowerStripMaterial,WS-ReadReceptacleMaterial,WS-ReadServerMaterial,WS-ReadStaticSwitchMaterial,WS-ReadUPSMaterial,WS-ReadSoftware | integration/api/odata/MaterialsAndSoftware, integration/api/odata/MaterialsAndSoftware({key}) | |
MaterialAndSoftware Structural Properties
Property | Type | Nullable | Mandatory | Read-Only | String length | Min Value | Max Value | Precision | Max Dec Places | Is Only Date | Description |
---|
ID | Edm.Int64 | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
Manufacturer | Edm.String | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
MaterialID | Edm.Int32 | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
MaterialName | Edm.String | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
MaterialNumber | Edm.Int32 | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
MaterialType | Edm.String | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | Entity representing the material type. Once an asset is created from a material, the asset type will be the material type from which was created. |
MaterialTypeID | Edm.Int32 | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | Entity representing the material type. Once an asset is created from a material, the asset type will be the material type from which was created. |
RecordStatus | Nlyte.Model.MaterialRecordStatus | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | Reflects the real status of the group as is in the data-center Canceled or Active. |
MaterialAndSoftware Navigational Properties
No navigational properties
Verb(s) | Required Permission(s) | Link | Description |
---|
MaterialCategory Structural Properties
Property | Type | Nullable | Mandatory | Read-Only | String length | Min Value | Max Value | Precision | Max Dec Places | Is Only Date | Description |
---|
Active | Edm.Boolean | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
MaterialCategoryID | Edm.Int32 | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
MaterialSubtypeID | Edm.Int32 | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | The material sub-type for which the category is available. |
Name | Edm.String | false | true |
false
| 255 | N/A | N/A | N/A | N/A | | |
MaterialCategory Navigational Properties
Verb(s) | Required Permission(s) | Link | Description |
---|
Get | WS-ReadFile | | |
Delete | WS-ModifyFile | | |
MaterialFile Structural Properties
No structural properties
MaterialFile Navigational Properties
No navigational properties
Verb(s) | Required Permission(s) | Link | Description |
---|
MaterialImage Structural Properties
Property | Type | Nullable | Mandatory | Read-Only | String length | Min Value | Max Value | Precision | Max Dec Places | Is Only Date | Description |
---|
ImageData | Edm.Binary | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
MaterialID | Edm.Int32 | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | Material for which the image was uploaded. |
MaterialImageID | Edm.Int32 | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
MaterialImageTypeID | Nlyte.Model.MaterialImageTypeEnum | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | Image representing the front or the back of the asset. |
MaterialImage Navigational Properties
Verb(s) | Required Permission(s) | Link | Description |
---|
MaterialSubtype Structural Properties
Property | Type | Nullable | Mandatory | Read-Only | String length | Min Value | Max Value | Precision | Max Dec Places | Is Only Date | Description |
---|
MaterialSubtypeID | Edm.Int32 | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
MaterialTypeID | Edm.Int32 | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
Name | Edm.String | false | true |
false
| 50 | N/A | N/A | N/A | N/A | | |
MaterialSubtype Navigational Properties
Verb(s) | Required Permission(s) | Link | Description |
---|
MaterialType Structural Properties
Property | Type | Nullable | Mandatory | Read-Only | String length | Min Value | Max Value | Precision | Max Dec Places | Is Only Date | Description |
---|
Detail | Edm.String | false | true |
false
| 50 | N/A | N/A | N/A | N/A | | Material type description |
MaterialTypeID | Edm.Int32 | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
MaterialType Navigational Properties
No navigational properties
Verb(s) | Required Permission(s) | Link | Description |
---|
Get | WS-ReadRoomPlan | | |
Patch | WS-ModifyRoomPlan | | |
Put | WS-ModifyRoomPlan | | |
Delete | WS-ModifyRoomPlan | | |
Post | WS-ModifyRoomPlan | | |
Measurement Structural Properties
Property | Type | Nullable | Mandatory | Read-Only | String length | Min Value | Max Value | Precision | Max Dec Places | Is Only Date | Description |
---|
DisplayLabels | Edm.Boolean | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
ID | Edm.Int32 | false | true |
false
| N/A | N/A | N/A | N/A | N/A | | |
LayerID | Edm.Int32 | true | true |
false
| N/A | N/A | N/A | N/A | N/A | | |
Name | Edm.String | true | false |
false
| 50 | N/A | N/A | N/A | N/A | | |
ParentLocationGroupID | Edm.Int32 | true | false |
true
| N/A | N/A | N/A | N/A | N/A | | |
PolygonID | Edm.Int32 | true | false |
true
| N/A | N/A | N/A | N/A | N/A | | |
SaveAction | Nlyte.Model.SaveActionEnum | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
Measurement Navigational Properties
Verb(s) | Required Permission(s) | Link | Description |
---|
MeasurementSystem Structural Properties
Property | Type | Nullable | Mandatory | Read-Only | String length | Min Value | Max Value | Precision | Max Dec Places | Is Only Date | Description |
---|
Description | Edm.String | false | true |
false
| 50 | N/A | N/A | N/A | N/A | | |
ID | Edm.Int32 | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
MeasurementSystem Navigational Properties
No navigational properties
Verb(s) | Required Permission(s) | Link | Description |
---|
Get | WS-ReadNetworkMaterial | integration/api/odata/ModuleNetworkMaterials, integration/api/odata/ModuleNetworkMaterials({key}) | |
Post | WS-AddNetworkMaterial | integration/api/odata/ModuleNetworkMaterials | |
PostWithKey | WS-ModifyNetworkMaterial | | |
Patch | WS-ModifyNetworkMaterial | integration/api/odata/ModuleNetworkMaterials({key}) | |
Delete | WS-ModifyNetworkMaterial | integration/api/odata/ModuleNetworkMaterials({key}) | |
ModuleNetworkMaterial Structural Properties
Property | Type | Nullable | Mandatory | Read-Only | String length | Min Value | Max Value | Precision | Max Dec Places | Is Only Date | Description |
---|
CalculatedMpafPowerConsumption | Edm.Decimal | true | false |
true
| N/A | N/A | N/A | N/A | N/A | | Read-only property, value provided by the service based on the PublishedPowerConsumption and the MpafOverride |
ConsumerPowerFactor | Edm.Decimal | false | false |
true
| N/A | N/A | N/A | N/A | N/A | | |
MaterialCategoryID | Edm.Int32 | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
MpafOverride | Edm.Decimal | true | false |
false
| N/A | 0.001 | 999 | 6 | 3 | | Value inserted by the user, while the material is in Planned status |
NumberOfColumns | Edm.Int32 | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
NumberOfRows | Edm.Int32 | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
PublishedPowerConsumption | Edm.Decimal | true | true |
false
| N/A | 0.001 | 999 | 6 | 3 | | Value inserted by the user, while the material is in Planned status |
WorkableFootPrintFront | Edm.Double | false | false |
false
| N/A | 0 | 999999999999.9999 | 16 | 4 | | |
WorkableFootPrintHeight | Edm.Double | false | false |
false
| N/A | 0 | 999999999999.9999 | 16 | 4 | | |
WorkableFootPrintRear | Edm.Double | false | false |
false
| N/A | 0 | 999999999999.9999 | 16 | 4 | | |
ModuleNetworkMaterial Navigational Properties
No navigational properties
Verb(s) | Required Permission(s) | Link | Description |
---|
Get | WS-ReadPeripheralMaterial | integration/api/odata/MonitorPeripheralMaterials, integration/api/odata/MonitorPeripheralMaterials({key}) | |
Post | WS-AddPeripheralMaterial | integration/api/odata/MonitorPeripheralMaterials | |
PostWithKey | WS-ModifyPeripheralMaterial | integration/api/odata/MonitorPeripheralMaterials({key}) | |
Patch | WS-ModifyPeripheralMaterial | integration/api/odata/MonitorPeripheralMaterials({key}) | |
Delete | WS-ModifyPeripheralMaterial | integration/api/odata/MonitorPeripheralMaterials({key}) | |
MonitorPeripheralMaterial Structural Properties
Property | Type | Nullable | Mandatory | Read-Only | String length | Min Value | Max Value | Precision | Max Dec Places | Is Only Date | Description |
---|
AirflowTypeID | Nlyte.Model.AirflowTypeEnum | true | true |
false
| N/A | N/A | N/A | N/A | N/A | | Selected air flow, from the available values defined in the administration area |
CalculatedMpafPowerConsumption | Edm.Decimal | true | false |
true
| N/A | N/A | N/A | N/A | N/A | | |
ConsumerPowerFactor | Edm.Decimal | false | false |
true
| N/A | N/A | N/A | N/A | N/A | | |
MpafOverride | Edm.Decimal | true | false |
false
| N/A | 0.001 | 999 | 6 | 3 | | Value inserted by the user, while the material is in Planned status |
PowerTypeID | Nlyte.Model.PowerTypeEnum | true | true |
false
| N/A | N/A | N/A | N/A | N/A | | Power type: phased or direct current |
PublishedPowerConsumption | Edm.Decimal | true | false |
false
| N/A | 0.001 | 999 | 6 | 3 | | Value inserted by the user, while the material is in Planned status |
RequiredPlugs | Edm.Int32 | true | true |
false
| N/A | N/A | N/A | N/A | N/A | | Value inserted by the user, while the material is in Planned status |
RequiresDiversePower | Edm.Boolean | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | Value available to be updated by the user only if RequiredPlugs TotalPlugs |
TotalPlugs | Edm.Int32 | true | true |
false
| N/A | N/A | N/A | N/A | N/A | | Value inserted by the user, while the material is in Planned status |
WorkableFootPrintFront | Edm.Double | false | false |
false
| N/A | 0 | 999999999999.9999 | 16 | 4 | | |
WorkableFootPrintHeight | Edm.Double | false | false |
false
| N/A | 0 | 999999999999.9999 | 16 | 4 | | |
WorkableFootPrintRear | Edm.Double | false | false |
false
| N/A | 0 | 999999999999.9999 | 16 | 4 | | |
MonitorPeripheralMaterial Navigational Properties
Verb(s) | Required Permission(s) | Link | Description |
---|
MountingType Structural Properties
Property | Type | Nullable | Mandatory | Read-Only | String length | Min Value | Max Value | Precision | Max Dec Places | Is Only Date | Description |
---|
Detail | Edm.String | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
MountingTypeID | Edm.Int32 | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
MountingType Navigational Properties
No navigational properties
Verb(s) | Required Permission(s) | Link | Description |
---|
Get | WS-ReadPeripheralMaterial | integration/api/odata/MousePeripheralMaterials, integration/api/odata/MousePeripheralMaterials({key}) | |
Post | WS-AddPeripheralMaterial | integration/api/odata/MousePeripheralMaterials | |
PostWithKey | WS-ModifyPeripheralMaterial | | |
Patch | WS-ModifyPeripheralMaterial | integration/api/odata/MousePeripheralMaterials({key}) | |
Delete | WS-ModifyPeripheralMaterial | integration/api/odata/MousePeripheralMaterials({key}) | |
MousePeripheralMaterial Structural Properties
No structural properties
MousePeripheralMaterial Navigational Properties
No navigational properties
Verb(s) | Required Permission(s) | Link | Description |
---|
MoveAssetControl Structural Properties
No structural properties
MoveAssetControl Navigational Properties
No navigational properties
Verb(s) | Required Permission(s) | Link | Description |
---|
MoveAssetControlValue Structural Properties
Property | Type | Nullable | Mandatory | Read-Only | String length | Min Value | Max Value | Precision | Max Dec Places | Is Only Date | Description |
---|
ProcessedAssetIDs | Collection(Edm.Int32) | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
MoveAssetControlValue Navigational Properties
No navigational properties
Verb(s) | Required Permission(s) | Link | Description |
---|
NameConvention Structural Properties
Property | Type | Nullable | Mandatory | Read-Only | String length | Min Value | Max Value | Precision | Max Dec Places | Is Only Date | Description |
---|
ConventionID | Edm.Int32 | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
ConventionName | Edm.String | false | true |
false
| 30 | N/A | N/A | N/A | N/A | | |
ConventionSetID | Edm.Int32 | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
Counter | Edm.Int32 | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
LocationGroupID | Edm.Int32 | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | Foreign key identifying the asset location |
NamingStandard | Edm.String | false | true |
false
| 15 | N/A | N/A | N/A | N/A | | |
Seed | Edm.Int32 | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
SuffixSize | Edm.Int16 | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
NameConvention Navigational Properties
No navigational properties
Verb(s) | Required Permission(s) | Link | Description |
---|
NameConventionSet Structural Properties
Property | Type | Nullable | Mandatory | Read-Only | String length | Min Value | Max Value | Precision | Max Dec Places | Is Only Date | Description |
---|
ConventionSetID | Edm.Int32 | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
ConventionSetName | Edm.String | false | true |
false
| 50 | N/A | N/A | N/A | N/A | | |
EntityTypeID | Edm.Int32 | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | The type being Chassis, Cabinet, Server, Host |
LocationGroupID | Edm.Int32 | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | Foreign key identifying the asset location |
NameConventionSet Navigational Properties
No navigational properties
Verb(s) | Required Permission(s) | Link | Description |
---|
Get | WS-ReadCabinet,WS-ReadServer,WS-ReadUPS,WS-ReadNetwork,WS-ReadPeripheral,WS-ReadStaticSwitch,WS-ReadReceptacle,WS-ReadKVMSwitch,WS-ReadAuxiliary,WS-ReadAirConditioning,WS-ReadChassis,WS-ReadPDU,WS-ReadPowerStrip,WS-ReadServerHost,WS-ReadNetworkMaterial,WS-ReadCabinetMaterial,WS-ReadPeripheralMaterial,WS-ReadKVMSwitchMaterial,WS-ReadServerMaterial,WS-ReadPDUMaterial,WS-ReadPowerStripMaterial,WS-ReadAirConditioningMaterial,WS-ReadReceptacleMaterial,WS-ReadChassisMaterial,WS-ReadUPSMaterial,WS-ReadAuxiliaryMaterial,WS-ReadStaticSwitchMaterial,WS-ReadCabinetMountedAssetMap,WS-ReadChassisMountedAssetMap | integration/api/odata/NavigatorAssets({key}), integration/api/odata/NavigatorAssets | |
NavigatorAsset Structural Properties
Property | Type | Nullable | Mandatory | Read-Only | String length | Min Value | Max Value | Precision | Max Dec Places | Is Only Date | Description |
---|
AssetID | Edm.Int32 | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
AssetName | Edm.String | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
AssetNumber | Edm.Int32 | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
AssetOperationalStatusID | Nlyte.Model.OperationalStatusEnum | false | false |
true
| N/A | N/A | N/A | N/A | N/A | | |
CabinetAssetID | Edm.Int32 | true | false |
true
| N/A | N/A | N/A | N/A | N/A | | |
ChassisAssetID | Edm.Int32 | true | false |
true
| N/A | N/A | N/A | N/A | N/A | | |
HasChildren | Edm.Boolean | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
LocationGroupID | Edm.Int32 | false | false |
true
| N/A | N/A | N/A | N/A | N/A | | |
MaterialSubType | Edm.String | true | false |
true
| N/A | N/A | N/A | N/A | N/A | | |
MaterialSubtypeID | Edm.Int32 | false | false |
true
| N/A | N/A | N/A | N/A | N/A | | |
MaterialType | Edm.String | true | false |
true
| N/A | N/A | N/A | N/A | N/A | | |
MaterialTypeID | Edm.Int32 | false | false |
true
| N/A | N/A | N/A | N/A | N/A | | |
ParentID | Edm.Int32 | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
ParentLocationGroupID | Edm.Int32 | true | false |
true
| N/A | N/A | N/A | N/A | N/A | | |
RecordStatus | Nlyte.Model.RecordStatusEnum | false | false |
true
| N/A | N/A | N/A | N/A | N/A | | |
NavigatorAsset Navigational Properties
Network Entity
: Asset
- Asset created from a material of type network, entity inheriting the Nlyte.Model.Asset entity
Verb(s) | Required Permission(s) | Link | Description |
---|
Get | WS-ReadNetwork | integration/api/odata/Networks, integration/api/odata/Networks({key}) | |
Delete | WS-ModifyNetwork | integration/api/odata/Networks({key}) | |
Patch | WS-ModifyNetwork | integration/api/odata/Networks({key}) | |
PostWithKey | WS-ModifyNetwork | integration/api/odata/Networks({key}) | |
Post | WS-AddNetwork | integration/api/odata/Networks | |
Network Structural Properties
Property | Type | Nullable | Mandatory | Read-Only | String length | Min Value | Max Value | Precision | Max Dec Places | Is Only Date | Description |
---|
AuditDate | Edm.DateTimeOffset | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
AuditStatusCorrect | Edm.Boolean | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
CabinetPosition | Nlyte.Model.CabinetPositionEnum | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
CardPosition | Edm.String | true | false |
false
| 20 | N/A | N/A | N/A | N/A | | Property used by network cards. |
ChassisMountedAssetMapID | Edm.Int32 | true | false |
true
| N/A | N/A | N/A | N/A | N/A | | |
HostingAssetID | Edm.Int32 | true | false |
true
| N/A | N/A | N/A | N/A | N/A | | |
LastAuditorAccountID | Edm.Int32 | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
NetworkUsageID | Edm.Int32 | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
PointType | Nlyte.Model.PointTypeEnum | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
RoomOrientation | Nlyte.Model.RoomOrientationEnum | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
TotalPlugs | Edm.Int32 | false | false |
true
| N/A | N/A | N/A | N/A | N/A | | |
Units | Nlyte.Model.UnitsEnum | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
Network Navigational Properties
Verb(s) | Required Permission(s) | Link | Description |
---|
NetworkCableType Structural Properties
Property | Type | Nullable | Mandatory | Read-Only | String length | Min Value | Max Value | Precision | Max Dec Places | Is Only Date | Description |
---|
Detail | Edm.String | false | true |
false
| 30 | N/A | N/A | N/A | N/A | | |
NetworkCableTypeID | Edm.Int32 | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
NetworkCableType Navigational Properties
No navigational properties
Verb(s) | Required Permission(s) | Link | Description |
---|
Key(s) |
---|
NetworkCardPortNameID |
NetworkCardPortName Structural Properties
Property | Type | Nullable | Mandatory | Read-Only | String length | Min Value | Max Value | Precision | Max Dec Places | Is Only Date | Description |
---|
Detail | Edm.String | false | true |
false
| 40 | N/A | N/A | N/A | N/A | | |
NetworkCardPortNameID | Edm.Int32 | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
NetworkCardPortName Navigational Properties
No navigational properties
Verb(s) | Required Permission(s) | Link | Description |
---|
Key(s) |
---|
NetworkConnectorTypeID |
NetworkConnectorType Structural Properties
Property | Type | Nullable | Mandatory | Read-Only | String length | Min Value | Max Value | Precision | Max Dec Places | Is Only Date | Description |
---|
Detail | Edm.String | false | true |
false
| 30 | N/A | N/A | N/A | N/A | | |
NetworkConnectorTypeID | Edm.Int32 | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
NetworkConnectorType Navigational Properties
No navigational properties
Verb(s) | Required Permission(s) | Link | Description |
---|
Get | WS-ReadNetworkConnection | integration/api/odata/NetworkGraphs, integration/api/odata/NetworkGraphs({key}) | |
Post | WS-AddNetworkConnection | integration/api/odata/NetworkGraphs | |
PostWithKey | WS-ModifyNetworkConnection | integration/api/odata/NetworkGraphs({key}) | |
Patch | WS-ModifyNetworkConnection | | |
Delete | WS-ModifyNetworkConnection | | |
NetworkGraph Structural Properties
Property | Type | Nullable | Mandatory | Read-Only | String length | Min Value | Max Value | Precision | Max Dec Places | Is Only Date | Description |
---|
ConnectionColor | Edm.Int32 | true | |
false
| | | | | | | |
ConnectionLength | Edm.Decimal | true | |
false
| | | | | | | |
ConnectionName | Edm.String | true | |
false
| | | | | | | |
ConnectionPortStatus | Nlyte.Model.PortState | true | true |
false
| N/A | N/A | N/A | N/A | N/A | | |
ConnectionTrunkName | Edm.String | true | |
false
| | | | | | | |
ConnectionType | Edm.Int32 | true | |
false
| | | | | | | |
DestinationPortLocation | Nlyte.Model.PortLocation | false | |
false
| | | | | | | |
NetworkGraphID | Edm.Int32 | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
PortEndNodeID | Edm.Int32 | true | true |
false
| N/A | N/A | N/A | N/A | N/A | | |
PortStartNodeID | Edm.Int32 | true | true |
false
| N/A | N/A | N/A | N/A | N/A | | |
SourcePortLocation | Nlyte.Model.PortLocation | false | |
false
| | | | | | | |
NetworkGraph Navigational Properties
Verb(s) | Required Permission(s) | Link | Description |
---|
Get | WS-ReadNetworkMaterial | integration/api/odata/NetworkMaterials, integration/api/odata/NetworkMaterials({key}) | |
Post | WS-AddNetworkMaterial | integration/api/odata/NetworkMaterials | |
PostWithKey | WS-ModifyNetworkMaterial | integration/api/odata/NetworkMaterials({key}) | |
Patch | WS-ModifyNetworkMaterial | integration/api/odata/NetworkMaterials({key}) | |
Delete | WS-ModifyNetworkMaterial | integration/api/odata/NetworkMaterials({key}) | |
NetworkMaterial Structural Properties
Property | Type | Nullable | Mandatory | Read-Only | String length | Min Value | Max Value | Precision | Max Dec Places | Is Only Date | Description |
---|
IsSuppliedMaterialUpdated | Edm.Boolean | false | false |
true
| N/A | N/A | N/A | N/A | N/A | | read-only property, set to true when a user modifies NetworkMaterialPorts |
MaterialSubtypeID | Edm.Int32 | true | false |
true
| N/A | N/A | N/A | N/A | N/A | | |
MountingTypeID | Nlyte.Model.MountingTypeEnum | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
NetworkSpeedMbps | Edm.Int32 | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | Network speed in Mbps |
StandardCopperPorts | Edm.Int32 | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
StandardFiberOpticPorts | Edm.Int32 | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
TotalCopperPorts | Edm.Int32 | true | false |
true
| N/A | N/A | N/A | N/A | N/A | | |
TotalFiberOpticPorts | Edm.Int32 | true | false |
true
| N/A | N/A | N/A | N/A | N/A | | |
TotalPlugs | Edm.Int32 | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | Value inserted by the user, while the material is in Planned status |
TotalUndefinedPorts | Edm.Int32 | true | |
false
| | | | | | | |
UHeight | Edm.Int64 | false | false |
true
| N/A | N/A | N/A | N/A | N/A | | |
NetworkMaterial Navigational Properties
Verb(s) | Required Permission(s) | Link | Description |
---|
Get | WS-ReadNetworkMaterial | | |
Patch | WS-ModifyNetworkMaterial | | |
PostWithKey | WS-ModifyNetworkMaterial | | |
NetworkMaterialPort Structural Properties
Property | Type | Nullable | Mandatory | Read-Only | String length | Min Value | Max Value | Precision | Max Dec Places | Is Only Date | Description |
---|
DefaultInternalPortName | Edm.String | true | false |
true
| 50 | N/A | N/A | N/A | N/A | | |
DefaultPortName | Edm.String | true | false |
true
| 50 | N/A | N/A | N/A | N/A | | |
ID | Edm.Int32 | false | true |
false
| N/A | N/A | N/A | N/A | N/A | | |
NetworkMaterialID | Edm.Int32 | false | false |
true
| N/A | N/A | N/A | N/A | N/A | | |
NetworkMaterialPortGroupMapID | Edm.Int32 | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
NewInternalPortName | Edm.String | true | false |
true
| 50 | N/A | N/A | N/A | N/A | | |
NewPortName | Edm.String | true | false |
true
| 50 | N/A | N/A | N/A | N/A | | |
PortType | Nlyte.Model.NetworkPortTypeEnum | false | |
false
| | | | | | | |
NetworkMaterialPort Navigational Properties
Verb(s) | Required Permission(s) | Link | Description |
---|
Get | WS-ReadNetworkMaterial | | |
Patch | WS-ModifyNetworkMaterial | | |
PostWithKey | WS-ModifyNetworkMaterial | | |
Key(s) |
---|
NetworkMaterialPortGroupID |
NetworkMaterialPortGroup Structural Properties
Property | Type | Nullable | Mandatory | Read-Only | String length | Min Value | Max Value | Precision | Max Dec Places | Is Only Date | Description |
---|
DefaultPortGroupName | Edm.String | true | false |
true
| 50 | N/A | N/A | N/A | N/A | | |
NetworkMaterialPortGroupID | Edm.Int32 | false | true |
false
| N/A | N/A | N/A | N/A | N/A | | |
NetworkPortGroupTypeID | Nlyte.Model.NetworkPortGroupTypeEnum | false | true |
false
| N/A | N/A | N/A | N/A | N/A | | |
NewPortGroupName | Edm.String | true | false |
true
| 50 | N/A | N/A | N/A | N/A | | |
NetworkMaterialPortGroup Navigational Properties
No navigational properties
Verb(s) | Required Permission(s) | Link | Description |
---|
Get | WS-ReadNetworkMaterial | | |
Patch | WS-ModifyNetworkMaterial | | |
PostWithKey | WS-ModifyNetworkMaterial | | |
Delete | WS-ModifyNetworkMaterial | | |
Key(s) |
---|
NetworkMaterialPortGroupMapID |
NetworkMaterialPortGroupMap Structural Properties
Property | Type | Nullable | Mandatory | Read-Only | String length | Min Value | Max Value | Precision | Max Dec Places | Is Only Date | Description |
---|
NetworkMaterialID | Edm.Int32 | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
NetworkMaterialInternalPortGroupID | Edm.Int32 | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
NetworkMaterialPortGroupID | Edm.Int32 | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
NetworkMaterialPortGroupMapID | Edm.Int32 | false | true |
false
| N/A | N/A | N/A | N/A | N/A | | |
NetworkMaterialPortGroupMap Navigational Properties
Verb(s) | Required Permission(s) | Link | Description |
---|
Get | WS-ReadNetworkConnection | integration/api/odata/NetworkPorts, integration/api/odata/NetworkPorts({key}) | |
Patch | WS-ModifyNetworkConnection | | |
PostWithKey | WS-ModifyNetworkConnection | | |
NetworkPort Structural Properties
Property | Type | Nullable | Mandatory | Read-Only | String length | Min Value | Max Value | Precision | Max Dec Places | Is Only Date | Description |
---|
ConnectorTypeID | Edm.Int32 | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
DataTypeID | Edm.Int32 | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
InternalConnectorTypeID | Edm.Int32 | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
InternalPortName | Edm.String | true | false |
false
| 50 | N/A | N/A | N/A | N/A | | Network Port Name (back). This must be unique per device. |
InternalPortStateID | Nlyte.Model.PortState | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | Connected or free |
LocationGroupID | Edm.Int32 | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | Foreign key identifying the asset location |
NetworkAssetID | Edm.Int32 | false | false |
true
| N/A | N/A | N/A | N/A | N/A | | |
NetworkInternalPortGroupID | Edm.Int32 | true | false |
true
| N/A | N/A | N/A | N/A | N/A | | |
NetworkPortGroupID | Edm.Int32 | true | false |
true
| N/A | N/A | N/A | N/A | N/A | | |
NetworkPortID | Edm.Int32 | false | true |
false
| N/A | N/A | N/A | N/A | N/A | | |
PhysicalAddress | Edm.String | true | false |
false
| 50 | N/A | N/A | N/A | N/A | | |
PortName | Edm.String | true | false |
false
| 50 | N/A | N/A | N/A | N/A | | Network Port Name (front). This must be unique per device. |
PortSpeedID | Edm.Int32 | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
PortStateID | Nlyte.Model.PortState | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | Connected or free |
PortTypeID | Nlyte.Model.NetworkPortTypeEnum | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
NetworkPort Navigational Properties
Verb(s) | Required Permission(s) | Link | Description |
---|
Get | WS-ReadNetworkConnection | | |
Post | WS-AddNetworkConnection | | |
Patch | WS-ModifyNetworkConnection | | |
PostWithKey | WS-ModifyNetworkConnection | | |
Delete | WS-ModifyNetworkConnection | | |
NetworkPortAssetIPAddressMap Structural Properties
Property | Type | Nullable | Mandatory | Read-Only | String length | Min Value | Max Value | Precision | Max Dec Places | Is Only Date | Description |
---|
ID | Edm.Int32 | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
IPAddressID | Edm.Int32 | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
NetworkPortID | Edm.Int32 | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
NetworkPortAssetIPAddressMap Navigational Properties
Verb(s) | Required Permission(s) | Link | Description |
---|
NetworkPortConnection Structural Properties
Property | Type | Nullable | Mandatory | Read-Only | String length | Min Value | Max Value | Precision | Max Dec Places | Is Only Date | Description |
---|
ConnectionColourID | Edm.Int32 | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
ConnectionLength | Edm.Decimal | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
ConnectionName | Edm.String | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
ConnectionTrunkName | Edm.String | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
ConnectionType | Edm.String | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
EndNodeAssetID | Edm.Int32 | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
EndNodeAssetName | Edm.String | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
EndNodeAssetNumber | Edm.Int32 | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
EndNodeAssetRecordStatus | Nlyte.Model.RecordStatusEnum | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
EndNodeAssetType | Edm.String | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | Destination asset Material type |
EndNodeConnectorType | Edm.String | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
EndNodeDataType | Edm.String | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
EndNodePortGroupID | Edm.Int32 | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
EndNodePortGroupName | Edm.String | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
EndNodePortGroupStatus | Nlyte.Model.PortState | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
EndNodePortGroupType | Nlyte.Model.NetworkPortGroupTypeEnum | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
EndNodePortID | Edm.Int32 | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
EndNodePortLocation | Edm.String | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
EndNodePortName | Edm.String | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
EndNodePortState | Nlyte.Model.PortState | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | Connected or free |
EndNodePortType | Nlyte.Model.NetworkPortTypeEnum | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
HasNav | Edm.Boolean | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
HasNotes | Edm.Boolean | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
IsAccessible | Edm.Boolean | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
IsProperPortGroupConnection | Edm.Boolean | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
NetworkGraphID | Edm.Int32 | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
NoteCount | Edm.Int32 | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
StartNodeAssetID | Edm.Int32 | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
StartNodeAssetName | Edm.String | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
StartNodeAssetNumber | Edm.Int32 | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
StartNodeAssetRecordStatus | Nlyte.Model.RecordStatusEnum | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
StartNodeConnectorType | Edm.String | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
StartNodeDataType | Edm.String | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
StartNodeHostName | Edm.String | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
StartNodeIPAddresses | Edm.String | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
StartNodeMACAddress | Edm.String | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
StartNodePortGroupID | Edm.Int32 | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
StartNodePortGroupName | Edm.String | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
StartNodePortGroupStatus | Nlyte.Model.PortState | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
StartNodePortGroupType | Nlyte.Model.NetworkPortGroupTypeEnum | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
StartNodePortID | Edm.Int32 | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
StartNodePortName | Edm.String | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
StartNodePortSpeed | Edm.String | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
StartNodePortState | Nlyte.Model.PortState | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | Connected or free |
StartNodePortType | Nlyte.Model.NetworkPortTypeEnum | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
NetworkPortConnection Navigational Properties
No navigational properties
Verb(s) | Required Permission(s) | Link | Description |
---|
Key(s) |
---|
NetworkPortDataTypeID |
NetworkPortDataType Structural Properties
Property | Type | Nullable | Mandatory | Read-Only | String length | Min Value | Max Value | Precision | Max Dec Places | Is Only Date | Description |
---|
Detail | Edm.String | false | true |
false
| 40 | N/A | N/A | N/A | N/A | | |
NetworkPortDataTypeID | Edm.Int32 | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
NetworkPortDataType Navigational Properties
No navigational properties
Verb(s) | Required Permission(s) | Link | Description |
---|
Get | WS-ReadNetworkConnection | integration/api/odata/NetworkPortGroups, integration/api/odata/NetworkPortGroups({key}) | |
Patch | WS-ModifyNetworkConnection | integration/api/odata/NetworkPortGroups({key}) | |
PostWithKey | WS-ModifyNetworkConnection | integration/api/odata/NetworkPortGroups({key}) | |
NetworkPortGroup Structural Properties
Property | Type | Nullable | Mandatory | Read-Only | String length | Min Value | Max Value | Precision | Max Dec Places | Is Only Date | Description |
---|
NetworkPortGroupConnectorTypeID | Edm.Int32 | true | false |
true
| N/A | N/A | N/A | N/A | N/A | | Connector Type of the group's sub-ports. GET returns no data because the data is not saved for NetworkPortGroup entity. |
NetworkPortGroupDataTypeID | Edm.Int32 | true | false |
true
| N/A | N/A | N/A | N/A | N/A | | Data Type of the group's sub-ports. GET returns no data because the data is not saved for NetworkPortGroup entity. |
NetworkPortGroupID | Edm.Int32 | false | false |
true
| N/A | N/A | N/A | N/A | N/A | | |
NetworkPortGroupName | Edm.String | true | true |
true
| 50 | N/A | N/A | N/A | N/A | | |
NetworkPortGroupPhysicalAddress | Edm.String | true | false |
true
| 50 | N/A | N/A | N/A | N/A | | Physical Address of the sub-ports. GET returns no data because the data is not saved for NetworkPortGroup entity. |
NetworkPortGroupPortTypeID | Nlyte.Model.NetworkPortTypeEnum | true | false |
true
| N/A | N/A | N/A | N/A | N/A | | Port Type of the sub-ports. GET returns no data because the data is not saved for NetworkPortGroup entity. |
NetworkPortGroupSpeedID | Edm.Int32 | true | false |
true
| N/A | N/A | N/A | N/A | N/A | | Speed of the group's sub-ports. GET returns no data because the data is not saved for NetworkPortGroup entity. |
NetworkPortGroupStateID | Nlyte.Model.PortState | true | false |
true
| N/A | N/A | N/A | N/A | N/A | | Port State of the sub-ports |
NetworkPortGroupTypeID | Nlyte.Model.NetworkPortGroupTypeEnum | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
NetworkPortGroup Navigational Properties
Verb(s) | Required Permission(s) | Link | Description |
---|
Key(s) |
---|
NetworkPortAssetIPAddressMapID |
NetworkPortGroupAssetIPAddressMap Structural Properties
Property | Type | Nullable | Mandatory | Read-Only | String length | Min Value | Max Value | Precision | Max Dec Places | Is Only Date | Description |
---|
NetworkPortAssetIPAddressMapID | Edm.Int32 | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
NetworkPortGroupID | Edm.Int32 | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
NetworkPortGroupAssetIPAddressMap Navigational Properties
Verb(s) | Required Permission(s) | Link | Description |
---|
Key(s) |
---|
NetworkPortServerHostIPAddressMapID |
NetworkPortGroupServerHostIPAddressMap Structural Properties
Property | Type | Nullable | Mandatory | Read-Only | String length | Min Value | Max Value | Precision | Max Dec Places | Is Only Date | Description |
---|
NetworkPortGroupID | Edm.Int32 | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
NetworkPortServerHostIPAddressMapID | Edm.Int32 | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
NetworkPortGroupServerHostIPAddressMap Navigational Properties
Verb(s) | Required Permission(s) | Link | Description |
---|
Get | WS-ReadNetworkConnection | integration/api/odata/NetworkPortGroupTypes, integration/api/odata/NetworkPortGroupTypes({key}) | |
Patch | WS-ModifyNetworkConnection | | |
PostWithKey | WS-ModifyNetworkConnection | | |
Key(s) |
---|
NetworkPortGroupTypeID |
NetworkPortGroupType Structural Properties
Property | Type | Nullable | Mandatory | Read-Only | String length | Min Value | Max Value | Precision | Max Dec Places | Is Only Date | Description |
---|
Detail | Edm.String | true | true |
false
| 30 | N/A | N/A | N/A | N/A | | |
NetworkPortGroupTypeID | Edm.Int32 | false | true |
false
| N/A | N/A | N/A | N/A | N/A | | |
TotalCopperPorts | Edm.Int32 | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
TotalFibreOpticPorts | Edm.Int32 | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
NetworkPortGroupType Navigational Properties
No navigational properties
Verb(s) | Required Permission(s) | Link | Description |
---|
Post | WS-AddNote | | |
Patch | WS-ModifyNote | | |
Delete | WS-ModifyNote | | |
Get | WS-ReadNote | | |
NetworkPortNote Structural Properties
No structural properties
NetworkPortNote Navigational Properties
No navigational properties
Verb(s) | Required Permission(s) | Link | Description |
---|
Get | WS-ReadNetworkConnection | | |
Patch | WS-ModifyNetworkConnection | | |
Delete | WS-ModifyNetworkConnection | | |
Post | WS-AddNetworkConnection | | |
PostWithKey | WS-ModifyNetworkConnection | | |
NetworkPortServerHostIPAddressMap Structural Properties
Property | Type | Nullable | Mandatory | Read-Only | String length | Min Value | Max Value | Precision | Max Dec Places | Is Only Date | Description |
---|
ID | Edm.Int32 | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
IPAddressID | Edm.Int32 | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
NetworkPortID | Edm.Int32 | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
ServerHostID | Edm.Int32 | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
NetworkPortServerHostIPAddressMap Navigational Properties
Verb(s) | Required Permission(s) | Link | Description |
---|
NetworkPortServiceProvider Structural Properties
Property | Type | Nullable | Mandatory | Read-Only | String length | Min Value | Max Value | Precision | Max Dec Places | Is Only Date | Description |
---|
AActlClliCode | Edm.String | true | false |
false
| 255 | N/A | N/A | N/A | N/A | | Access Customer Terminal Location (ACTL) or CLLI Code (Common Language Location Identifier) of the customer facility terminal location. This is the port that the vendor would like to be used for the service . |
ACfaLoaLocation | Edm.String | true | false |
false
| 255 | N/A | N/A | N/A | N/A | | Channel facility assignment (CFA) captures the service provider's connection point; Letter of authority (LOA) provides permission to create a connection to and from the provider |
ACrossConnectOrderedLocation | Edm.String | true | false |
false
| 255 | N/A | N/A | N/A | N/A | | This is to track if a connection has been ordered |
AMonthlyLocalLoopCircuitCost | Edm.Decimal | true | false |
false
| N/A | 0 | 99999999999.99 | 13 | 2 | | The monthly cost of the A local circuit |
ATotalMonthlyRecurringCost | Edm.Decimal | true | false |
false
| N/A | 0 | 99999999999.99 | 13 | 2 | | The total monthly cost of the local circuit |
BillingID | Edm.String | true | false |
false
| 255 | N/A | N/A | N/A | N/A | | Billing code for the Circuit |
BusinessUnitID | Edm.String | true | false |
false
| 255 | N/A | N/A | N/A | N/A | | This is to track the business unit assigned to a port |
CircuitAcceptanceDate | Edm.DateTimeOffset | true | false |
false
| N/A | N/A | N/A | N/A | N/A | IsOnlyDate | The acceptance date |
CircuitContractEndDate | Edm.DateTimeOffset | true | false |
false
| N/A | N/A | N/A | N/A | N/A | IsOnlyDate | The date the circuits service contractual obligation ends |
CircuitContractStartDate | Edm.DateTimeOffset | true | false |
false
| N/A | N/A | N/A | N/A | N/A | IsOnlyDate | The contract date to start the service |
CircuitDecommissionCode | Edm.String | true | false |
false
| 255 | N/A | N/A | N/A | N/A | | Internal business code for tracking circuits that have been decommissioned |
CircuitDecommissionDate | Edm.DateTimeOffset | true | false |
false
| N/A | N/A | N/A | N/A | N/A | IsOnlyDate | The date the circuit service is turned off |
CircuitProjectID | Edm.String | true | false |
false
| 255 | N/A | N/A | N/A | N/A | | The project that the circuit is requested under |
CircuitQuoteID | Edm.String | true | false |
false
| 255 | N/A | N/A | N/A | N/A | | The ID of the vendor service quote |
CircuitServiceID | Edm.String | true | false |
false
| 255 | N/A | N/A | N/A | N/A | | tracking the service offering ID number |
ClientID | Edm.String | true | false |
false
| 255 | N/A | N/A | N/A | N/A | | This is to track the business units client assigned to a port |
ClientName | Edm.String | true | false |
false
| 255 | N/A | N/A | N/A | N/A | | This is to track the business units client assigned to a port |
ConfirmedWithAccounting | Edm.String | true | false |
false
| 255 | N/A | N/A | N/A | N/A | | Confirmed with accounting |
CustomerLoa | Edm.String | true | false |
false
| 255 | N/A | N/A | N/A | N/A | | Letter of authority (LOA) provides permission to create a connection to and from the provider |
DecommissionVendorID | Edm.String | true | false |
false
| 255 | N/A | N/A | N/A | N/A | | For tracking the 3rd party decommissioning a circuit |
InterconnectRefNumber | Edm.String | true | false |
false
| 255 | N/A | N/A | N/A | N/A | | interconnect vendor reference number |
MonthlyInterconnectFee | Edm.Decimal | true | false |
false
| N/A | 0 | 99999999999.99 | 13 | 2 | | The monthly cost for the interconnect |
MonthlyTariffs | Edm.Decimal | true | false |
false
| N/A | 0 | 99999999999.99 | 13 | 2 | | The TAX cost of the local circuit |
MsaContractExpirationDate | Edm.DateTimeOffset | true | false |
false
| N/A | N/A | N/A | N/A | N/A | IsOnlyDate | The master services agreement contract number with the vendor |
MsaContractNumber | Edm.String | true | false |
false
| 255 | N/A | N/A | N/A | N/A | | The master services agreement contract number with the vendor |
NetworkPortID | Edm.Int32 | true | false |
true
| N/A | N/A | N/A | N/A | N/A | | |
PoNumber | Edm.String | true | false |
false
| 255 | N/A | N/A | N/A | N/A | | PO number |
ProductLine | Edm.String | true | false |
false
| 255 | N/A | N/A | N/A | N/A | | Tracking the service offering |
ProjectName | Edm.String | true | false |
false
| 255 | N/A | N/A | N/A | N/A | | This is the project for the new port |
RenewalCircuit | Edm.String | true | false |
false
| 255 | N/A | N/A | N/A | N/A | | Tracking if the service is a renewal service Yes or no |
RequisitionNumber | Edm.String | true | false |
false
| 255 | N/A | N/A | N/A | N/A | | This is the requisition number for the new circuit |
SavingsCode | Edm.String | true | false |
false
| 255 | N/A | N/A | N/A | N/A | | For tracking a cost center |
VendorAccountNumber | Edm.String | true | false |
false
| 255 | N/A | N/A | N/A | N/A | | Vendor provided billing account number |
VendorCircuitID | Edm.String | true | false |
false
| 255 | N/A | N/A | N/A | N/A | | Vendor provided circuit ID for tracking |
VendorCircuitStatus | Edm.String | true | false |
false
| 255 | N/A | N/A | N/A | N/A | | The circuit if active or decommissioned |
VendorCircuitType | Edm.String | true | false |
false
| 255 | N/A | N/A | N/A | N/A | | The type of service provided by the vendor |
VendorName | Edm.String | true | false |
false
| 255 | N/A | N/A | N/A | N/A | | The name of the service provider (vendor) |
VendorOrderNumber | Edm.String | true | false |
false
| 255 | N/A | N/A | N/A | N/A | | The ID of the vendor order number |
ZActlClliCode | Edm.String | true | false |
false
| 255 | N/A | N/A | N/A | N/A | | Access Customer Terminal Location (ACTL) or CLLI Code (Common Language Location Identifier) of the customer facility terminal location. This is the port that the vendor would like to be used for the service. |
ZCfaLoaLocation | Edm.String | true | false |
false
| 255 | N/A | N/A | N/A | N/A | | Channel facility assignment (CFA) captures the service provider's connection point; Letter of authority (LOA) provides permission to create a connection to and from the provider. |
ZCrossConnectOrderedLocation | Edm.String | true | false |
false
| 255 | N/A | N/A | N/A | N/A | | This is to track if a connection has been ordered |
ZMonthlyLocalLoopCircuitCost | Edm.Decimal | true | false |
false
| N/A | 0 | 99999999999.99 | 13 | 2 | | The monthly cost of the Z local loop/circuit |
ZTotalMonthlyRecurringCost | Edm.Decimal | true | false |
false
| N/A | 0 | 99999999999.99 | 13 | 2 | | The total monthly cost of the local circuit |
NetworkPortServiceProvider Navigational Properties
Verb(s) | Required Permission(s) | Link | Description |
---|
NetworkSpeed Structural Properties
Property | Type | Nullable | Mandatory | Read-Only | String length | Min Value | Max Value | Precision | Max Dec Places | Is Only Date | Description |
---|
Detail | Edm.Int64 | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
NetworkSpeedID | Edm.Int32 | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
NetworkSpeed Navigational Properties
No navigational properties
Verb(s) | Required Permission(s) | Link | Description |
---|
NetworkUsage Structural Properties
Property | Type | Nullable | Mandatory | Read-Only | String length | Min Value | Max Value | Precision | Max Dec Places | Is Only Date | Description |
---|
Detail | Edm.String | false | true |
false
| 30 | N/A | N/A | N/A | N/A | | |
NetworkUsageID | Edm.Int32 | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
NetworkUsage Navigational Properties
No navigational properties
Verb(s) | Required Permission(s) | Link | Description |
---|
Post | WS-AddNote | | |
Patch | WS-ModifyNote | | |
Delete | WS-ModifyNote | | |
Get | WS-ReadNote | | |
Note Structural Properties
Property | Type | Nullable | Mandatory | Read-Only | String length | Min Value | Max Value | Precision | Max Dec Places | Is Only Date | Description |
---|
Body | Edm.String | false | true |
false
| 800 | N/A | N/A | N/A | N/A | | |
DateTimeStamp | Edm.DateTimeOffset | true | false |
true
| N/A | N/A | N/A | N/A | N/A | | |
EntityID | Edm.Int32 | false | false |
true
| N/A | N/A | N/A | N/A | N/A | | |
Name | Edm.String | true | false |
true
| 152 | N/A | N/A | N/A | N/A | | |
NoteID | Edm.Int32 | false | false |
true
| N/A | N/A | N/A | N/A | N/A | | |
Subject | Edm.String | false | true |
false
| 60 | N/A | N/A | N/A | N/A | | |
Note Navigational Properties
No navigational properties
Verb(s) | Required Permission(s) | Link | Description |
---|
OperationalUse Structural Properties
Property | Type | Nullable | Mandatory | Read-Only | String length | Min Value | Max Value | Precision | Max Dec Places | Is Only Date | Description |
---|
Detail | Edm.String | false | true |
false
| 50 | N/A | N/A | N/A | N/A | | |
OperationalUseID | Edm.Int32 | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
OperationalUse Navigational Properties
No navigational properties
Verb(s) | Required Permission(s) | Link | Description |
---|
OutputConnector Structural Properties
Property | Type | Nullable | Mandatory | Read-Only | String length | Min Value | Max Value | Precision | Max Dec Places | Is Only Date | Description |
---|
AssetID | Edm.Int32 | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | The asset id of the power asset |
BreakerID | Edm.Int32 | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | PDU Breaker ID |
Description | Edm.String | true | false |
false
| 50 | N/A | N/A | N/A | N/A | | Outlet Name. This must be unique for a power asset. |
Enabled | Edm.Boolean | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
LocationGroupID | Edm.Int32 | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | Foreign key identifying the power asset location |
MaxA | Edm.Int32 | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
OutputConnectorID | Edm.Int32 | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
OutputConnectorMaterialID | Edm.Int32 | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | Foreign key identifying the material outlet |
OutputConnector Navigational Properties
Verb(s) | Required Permission(s) | Link | Description |
---|
Key(s) |
---|
OutputConnectorMaterialID |
OutputConnectorMaterial Structural Properties
Property | Type | Nullable | Mandatory | Read-Only | String length | Min Value | Max Value | Precision | Max Dec Places | Is Only Date | Description |
---|
Description | Edm.String | true | false |
false
| 50 | N/A | N/A | N/A | N/A | | |
MaterialID | Edm.Int32 | true | false |
true
| N/A | N/A | N/A | N/A | N/A | | The parent material, holding the outlet |
MaxA | Edm.Int32 | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
OutputConnectorMaterialID | Edm.Int32 | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | Primary key |
OutputConnectorTypeID | Edm.Int32 | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | The ID of one of the predefined output connector types. |
Position | Edm.Int32 | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | Plug position, read-only information |
PowerTypeID | Nlyte.Model.PowerTypeEnum | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | Power type inherited from the parent material |
OutputConnectorMaterial Navigational Properties
Verb(s) | Required Permission(s) | Link | Description |
---|
Key(s) |
---|
OutputConnectorMaterialWireID |
OutputConnectorMaterialWire Structural Properties
Property | Type | Nullable | Mandatory | Read-Only | String length | Min Value | Max Value | Precision | Max Dec Places | Is Only Date | Description |
---|
OutputConnectorMaterialID | Edm.Int32 | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | The outlet material |
OutputConnectorMaterialWireID | Edm.Int32 | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
SlotPosition | Edm.Int32 | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
WirePosition | Edm.Int32 | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
OutputConnectorMaterialWire Navigational Properties
Verb(s) | Required Permission(s) | Link | Description |
---|
Get | WS-ReadOutputConnectorRealtimeData | integration/api/odata/OutputConnectorRealTimeData, integration/api/odata/OutputConnectorRealTimeData({key}) | |
Key(s) |
---|
OutputConnectorRealtimeDataID |
OutputConnectorRealTimeData Structural Properties
Property | Type | Nullable | Mandatory | Read-Only | String length | Min Value | Max Value | Precision | Max Dec Places | Is Only Date | Description |
---|
AssetID | Edm.Int32 | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
ConnectorNo | Edm.Int32 | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
LastUpdated | Edm.DateTimeOffset | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
LocationGroupID | Edm.Int32 | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
OutputConnectorID | Edm.Int32 | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
OutputConnectorRealtimeDataID | Edm.Int32 | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
ProviderID | Edm.Int32 | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
RealtimeLoad | Edm.Decimal | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
RealtimeLoadAverage | Edm.Decimal | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
RealtimeLoadMax | Edm.Decimal | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
RealtimeLoadMin | Edm.Decimal | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
RealtimePower | Edm.Decimal | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
RealtimePowerAverage | Edm.Decimal | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
RealtimePowerMax | Edm.Decimal | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
RealtimePowerMin | Edm.Decimal | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
RealtimeTotalEnergy | Edm.Decimal | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
RealtimeVoltage | Edm.Decimal | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
RealtimeVoltageAverage | Edm.Decimal | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
RealtimeVoltageMax | Edm.Decimal | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
RealtimeVoltageMin | Edm.Decimal | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
OutputConnectorRealTimeData Navigational Properties
No navigational properties
Verb(s) | Required Permission(s) | Link | Description |
---|
Get | WS-ReadOutputConnectorRealtimePhaseData | integration/api/odata/OutputConnectorRealTimePhaseData, integration/api/odata/OutputConnectorRealTimePhaseData({key}) | |
Key(s) |
---|
OutputConnectorRealtimePhaseDataID |
OutputConnectorRealTimePhaseData Structural Properties
Property | Type | Nullable | Mandatory | Read-Only | String length | Min Value | Max Value | Precision | Max Dec Places | Is Only Date | Description |
---|
AssetID | Edm.Int32 | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
ConnectorNo | Edm.Int32 | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
LastUpdated | Edm.DateTimeOffset | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
LocationGroupID | Edm.Int32 | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
OutputConnectorID | Edm.Int32 | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
OutputConnectorRealtimePhaseDataID | Edm.Int32 | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
Phase1RealtimeLoad | Edm.Decimal | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
Phase1RealtimeLoadAverage | Edm.Decimal | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
Phase1RealtimeLoadMax | Edm.Decimal | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
Phase1RealtimeLoadMin | Edm.Decimal | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
Phase1RealtimePower | Edm.Decimal | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
Phase1RealtimePowerAverage | Edm.Decimal | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
Phase1RealtimePowerMax | Edm.Decimal | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
Phase1RealtimePowerMin | Edm.Decimal | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
Phase1RealtimeVoltage | Edm.Decimal | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
Phase1RealtimeVoltageAverage | Edm.Decimal | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
Phase1RealtimeVoltageMax | Edm.Decimal | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
Phase1RealtimeVoltageMin | Edm.Decimal | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
Phase2RealtimeLoad | Edm.Decimal | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
Phase2RealtimeLoadAverage | Edm.Decimal | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
Phase2RealtimeLoadMax | Edm.Decimal | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
Phase2RealtimeLoadMin | Edm.Decimal | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
Phase2RealtimePower | Edm.Decimal | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
Phase2RealtimePowerAverage | Edm.Decimal | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
Phase2RealtimePowerMax | Edm.Decimal | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
Phase2RealtimePowerMin | Edm.Decimal | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
Phase2RealtimeVoltage | Edm.Decimal | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
Phase2RealtimeVoltageAverage | Edm.Decimal | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
Phase2RealtimeVoltageMax | Edm.Decimal | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
Phase2RealtimeVoltageMin | Edm.Decimal | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
Phase3RealtimeLoad | Edm.Decimal | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
Phase3RealtimeLoadAverage | Edm.Decimal | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
Phase3RealtimeLoadMax | Edm.Decimal | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
Phase3RealtimeLoadMin | Edm.Decimal | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
Phase3RealtimePower | Edm.Decimal | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
Phase3RealtimePowerAverage | Edm.Decimal | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
Phase3RealtimePowerMax | Edm.Decimal | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
Phase3RealtimePowerMin | Edm.Decimal | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
Phase3RealtimeVoltage | Edm.Decimal | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
Phase3RealtimeVoltageAverage | Edm.Decimal | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
Phase3RealtimeVoltageMax | Edm.Decimal | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
Phase3RealtimeVoltageMin | Edm.Decimal | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
ProviderID | Edm.Int32 | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
OutputConnectorRealTimePhaseData Navigational Properties
No navigational properties
Verb(s) | Required Permission(s) | Link | Description |
---|
Key(s) |
---|
OutputConnectorTypeID |
OutputConnectorType Structural Properties
Property | Type | Nullable | Mandatory | Read-Only | String length | Min Value | Max Value | Precision | Max Dec Places | Is Only Date | Description |
---|
Name | Edm.String | false | true |
false
| 50 | N/A | N/A | N/A | N/A | | |
OutputConnectorTypeID | Edm.Int32 | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
OutputConnectorType Navigational Properties
No navigational properties
Verb(s) | Required Permission(s) | Link | Description |
---|
Key(s) |
---|
OutputConnectorWireID |
OutputConnectorWire Structural Properties
Property | Type | Nullable | Mandatory | Read-Only | String length | Min Value | Max Value | Precision | Max Dec Places | Is Only Date | Description |
---|
OutputConnectorID | Edm.Int32 | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
OutputConnectorWireID | Edm.Int32 | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
SlotPosition | Edm.Int32 | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
WireID | Edm.Int32 | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
OutputConnectorWire Navigational Properties
Verb(s) | Required Permission(s) | Link | Description |
---|
Overlay Structural Properties
Property | Type | Nullable | Mandatory | Read-Only | String length | Min Value | Max Value | Precision | Max Dec Places | Is Only Date | Description |
---|
Colour | Edm.String | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
Result | Edm.String | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
RoomItemID | Edm.Int32 | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
Value | Edm.String | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
Overlay Navigational Properties
No navigational properties
Verb(s) | Required Permission(s) | Link | Description |
---|
PagedAutoAllocateSearchResult Structural Properties
Property | Type | Nullable | Mandatory | Read-Only | String length | Min Value | Max Value | Precision | Max Dec Places | Is Only Date | Description |
---|
CurrentPage | Collection(Nlyte.Model.AutoAllocateSearchResult) | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
RangeEnd | Edm.Int32 | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
RangeStart | Edm.Int32 | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
SearchClientId | Edm.String | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
TotalCount | Edm.Int32 | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
PagedAutoAllocateSearchResult Navigational Properties
No navigational properties
Verb(s) | Required Permission(s) | Link | Description |
---|
Get | WS-ReadNetworkMaterial | integration/api/odata/PanelNetworkMaterials, integration/api/odata/PanelNetworkMaterials({key}) | |
Post | WS-AddNetworkMaterial | integration/api/odata/PanelNetworkMaterials | |
PostWithKey | WS-ModifyNetworkMaterial | | |
Patch | WS-ModifyNetworkMaterial | integration/api/odata/PanelNetworkMaterials({key}) | |
Delete | WS-ModifyNetworkMaterial | integration/api/odata/PanelNetworkMaterials({key}) | |
PanelNetworkMaterial Structural Properties
Property | Type | Nullable | Mandatory | Read-Only | String length | Min Value | Max Value | Precision | Max Dec Places | Is Only Date | Description |
---|
MaterialCategoryID | Edm.Int32 | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
NetworkPanelTypeID | Nlyte.Model.NetworkPanelTypeEnum | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
WorkableFootPrintFront | Edm.Double | false | false |
false
| N/A | 0 | 999999999999.9999 | 16 | 4 | | |
WorkableFootPrintHeight | Edm.Double | false | false |
false
| N/A | 0 | 999999999999.9999 | 16 | 4 | | |
WorkableFootPrintRear | Edm.Double | false | false |
false
| N/A | 0 | 999999999999.9999 | 16 | 4 | | |
PanelNetworkMaterial Navigational Properties
No navigational properties
PDU Entity
: Asset
- Asset created from a material of type PDU, entity inheriting the Nlyte.Model.Asset entity
Verb(s) | Required Permission(s) | Link | Description |
---|
Get | WS-ReadPDU | integration/api/odata/PDUs, integration/api/odata/PDUs({key}) | |
Delete | WS-ModifyPDU | integration/api/odata/PDUs({key}) | |
Patch | WS-ModifyPDU | integration/api/odata/PDUs({key}) | |
PostWithKey | WS-ModifyPDU | integration/api/odata/PDUs({key}) | |
Post | WS-AddPDU | integration/api/odata/PDUs | |
PDU Structural Properties
Property | Type | Nullable | Mandatory | Read-Only | String length | Min Value | Max Value | Precision | Max Dec Places | Is Only Date | Description |
---|
AuditDate | Edm.DateTimeOffset | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
AuditStatusCorrect | Edm.Boolean | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
CurrentPowerFactor | Edm.Decimal | true | false |
true
| N/A | N/A | N/A | N/A | N/A | | Read-only property representing the percentage of power drawn by a PDD asset that is available to its consumers |
DirectCurrentVoltage | Edm.Double | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
IsMasterRedundancyDevice | Edm.Boolean | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | Value inserted by the user |
LastAuditorAccountID | Edm.Int32 | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
ManufactureDate | Edm.DateTimeOffset | true | false |
false
| N/A | N/A | N/A | N/A | N/A | IsOnlyDate | |
OnePhaseVoltage | Edm.Double | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
OutputCount | Edm.Int32 | false | false |
true
| N/A | N/A | N/A | N/A | N/A | | |
PowerFactor | Edm.Decimal | true | false |
false
| N/A | 0 | 99.99 | 4 | 2 | | |
PowerFactorOverride | Edm.Decimal | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | Value provided by the user, overriding the CurrentPowerFactor value |
RatedKVA | Edm.Int32 | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
RealtimePowerFactor | Edm.Decimal | true | false |
true
| N/A | N/A | N/A | N/A | N/A | | Read-only value. |
ServiceDate | Edm.DateTimeOffset | true | false |
false
| N/A | N/A | N/A | N/A | N/A | IsOnlyDate | |
ThreePhaseVoltage | Edm.Double | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
TwoPhaseVoltage | Edm.Double | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
UpsName | Edm.String | true | false |
false
| 30 | N/A | N/A | N/A | N/A | | |
UseAlternatingPositions | Edm.Boolean | false | true |
false
| N/A | N/A | N/A | N/A | N/A | | |
PDU Navigational Properties
PDUMaterial Entity
: Material
- Material type inheriting properties from the base type
Verb(s) | Required Permission(s) | Link | Description |
---|
Get | WS-ReadPDUMaterial | integration/api/odata/PDUMaterials, integration/api/odata/PDUMaterials({key}) | |
Post | WS-AddPDUMaterial | integration/api/odata/PDUMaterials | |
PostWithKey | WS-ModifyPDUMaterial | | |
Patch | WS-ModifyPDUMaterial | integration/api/odata/PDUMaterials({key}) | |
Delete | WS-ModifyPDUMaterial | integration/api/odata/PDUMaterials({key}) | |
PDUMaterial Structural Properties
Property | Type | Nullable | Mandatory | Read-Only | String length | Min Value | Max Value | Precision | Max Dec Places | Is Only Date | Description |
---|
CalculatedMaxKW | Edm.Decimal | true | false |
true
| N/A | N/A | N/A | N/A | N/A | | |
DirectCurrentVoltage | Edm.Double | false | false |
false
| N/A | 0 | 999999999999999 | 15 | 0 | | |
DistributorPowerFactor | Edm.Decimal | false | false |
true
| N/A | N/A | N/A | N/A | N/A | | |
MaterialCategoryID | Edm.Int32 | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
MaterialSubtypeID | Edm.Int32 | true | false |
true
| N/A | N/A | N/A | N/A | N/A | | |
MaxA | Edm.Decimal | true | false |
false
| N/A | 0 | 99999.999 | 8 | 3 | | |
MaxV | Edm.Decimal | true | false |
false
| N/A | 0 | 99999.999 | 8 | 3 | | |
OnePhaseVoltage | Edm.Double | false | true |
false
| N/A | 1 | 999999999999999 | 15 | 0 | | |
ThreePhaseVoltage | Edm.Double | false | true |
false
| N/A | 1 | 999999999999999 | 15 | 0 | | |
TwoPhaseVoltage | Edm.Double | false | true |
false
| N/A | 1 | 999999999999999 | 15 | 0 | | |
UHeight | Edm.Int64 | false | false |
true
| N/A | N/A | N/A | N/A | N/A | | |
WorkableFootPrintFront | Edm.Double | false | false |
false
| N/A | 0 | 999999999999.9999 | 16 | 4 | | |
WorkableFootPrintHeight | Edm.Double | false | false |
false
| N/A | 0 | 999999999999.9999 | 16 | 4 | | |
WorkableFootPrintRear | Edm.Double | false | false |
false
| N/A | 0 | 999999999999.9999 | 16 | 4 | | |
PDUMaterial Navigational Properties
No navigational properties
Peripheral Entity
: Asset
- Asset created from a material of type peripheral, entity inheriting the Nlyte.Model.Asset entity
Verb(s) | Required Permission(s) | Link | Description |
---|
Get | WS-ReadPeripheral | integration/api/odata/Peripherals, integration/api/odata/Peripherals({key}) | |
Patch | WS-ModifyPeripheral | integration/api/odata/Peripherals({key}) | |
PostWithKey | WS-ModifyPeripheral | integration/api/odata/Peripherals({key}) | |
Delete | WS-ModifyPeripheral | integration/api/odata/Peripherals({key}) | |
Post | WS-AddPeripheral | integration/api/odata/Peripherals | |
Peripheral Structural Properties
Property | Type | Nullable | Mandatory | Read-Only | String length | Min Value | Max Value | Precision | Max Dec Places | Is Only Date | Description |
---|
AuditDate | Edm.DateTimeOffset | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
AuditStatusCorrect | Edm.Boolean | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
DiskCapacity | Edm.Double | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
LastAuditorAccountID | Edm.Int32 | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
OwnerAssetID | Edm.Int32 | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
StorageUsageID | Edm.Int32 | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
TotalMemory | Edm.Double | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
TotalPlugs | Edm.Int32 | false | false |
true
| N/A | N/A | N/A | N/A | N/A | | |
Peripheral Navigational Properties
Verb(s) | Required Permission(s) | Link | Description |
---|
Get | WS-ReadPeripheralAssetLink | | |
Patch | WS-ModifyPeripheralAssetLink | | |
Delete | WS-ModifyPeripheralAssetLink | | |
Post | WS-AddPeripheralAssetLink | | |
Key(s) |
---|
PeripheralAssetLinkID |
PeripheralAssetLink Structural Properties
Property | Type | Nullable | Mandatory | Read-Only | String length | Min Value | Max Value | Precision | Max Dec Places | Is Only Date | Description |
---|
ConnectedAssetID | Edm.Int32 | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
ConnectedAssetSlot | Edm.String | true | false |
false
| 100 | N/A | N/A | N/A | N/A | | |
PeripheralAssetID | Edm.Int32 | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
PeripheralAssetLinkID | Edm.Int32 | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
PeripheralAssetLink Navigational Properties
Verb(s) | Required Permission(s) | Link | Description |
---|
Post | WS-AddNote | | |
Patch | WS-ModifyNote | | |
Delete | WS-ModifyNote | | |
Get | WS-ReadNote | | |
PeripheralAssetLinkNote Structural Properties
No structural properties
PeripheralAssetLinkNote Navigational Properties
No navigational properties
Verb(s) | Required Permission(s) | Link | Description |
---|
Get | WS-ReadPeripheralMaterial | integration/api/odata/PeripheralMaterials, integration/api/odata/PeripheralMaterials({key}) | |
Post | WS-AddPeripheralMaterial | integration/api/odata/PeripheralMaterials | |
PostWithKey | WS-ModifyPeripheralMaterial | | |
Patch | WS-ModifyPeripheralMaterial | integration/api/odata/PeripheralMaterials({key}) | |
Delete | WS-ModifyPeripheralMaterial | integration/api/odata/PeripheralMaterials({key}) | |
PeripheralMaterial Structural Properties
Property | Type | Nullable | Mandatory | Read-Only | String length | Min Value | Max Value | Precision | Max Dec Places | Is Only Date | Description |
---|
MaterialCategoryID | Edm.Int32 | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
MountingTypeID | Nlyte.Model.MountingTypeEnum | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
UHeight | Edm.Int64 | false | false |
true
| N/A | N/A | N/A | N/A | N/A | | |
PeripheralMaterial Navigational Properties
No navigational properties
Verb(s) | Required Permission(s) | Link | Description |
---|
Permission Structural Properties
Property | Type | Nullable | Mandatory | Read-Only | String length | Min Value | Max Value | Precision | Max Dec Places | Is Only Date | Description |
---|
Description | Edm.String | true | false |
false
| 255 | N/A | N/A | N/A | N/A | | |
Detail | Edm.String | false | true |
false
| 50 | N/A | N/A | N/A | N/A | | Permission |
PermissionID | Edm.Int32 | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
Permission Navigational Properties
No navigational properties
Verb(s) | Required Permission(s) | Link | Description |
---|
Get | WS-ReadPhysicalPartition | | |
Patch | WS-ModifyPhysicalPartition | | |
Delete | WS-ModifyPhysicalPartition | | |
Post | WS-AddPhysicalPartition | | |
Key(s) |
---|
PhysicalPartitionID |
PhysicalPartition Structural Properties
Property | Type | Nullable | Mandatory | Read-Only | String length | Min Value | Max Value | Precision | Max Dec Places | Is Only Date | Description |
---|
PhysicalPartitionID | Edm.Int32 | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
PhysicalPartitionName | Edm.String | false | true |
false
| 30 | N/A | N/A | N/A | N/A | | |
PhysicalPartitionTypeID | Edm.Int32 | true | true |
false
| N/A | N/A | N/A | N/A | N/A | | |
ServerAssetID | Edm.Int32 | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
PhysicalPartition Navigational Properties
Verb(s) | Required Permission(s) | Link | Description |
---|
Key(s) |
---|
PhysicalPartitionTypeID |
PhysicalPartitionType Structural Properties
Property | Type | Nullable | Mandatory | Read-Only | String length | Min Value | Max Value | Precision | Max Dec Places | Is Only Date | Description |
---|
Detail | Edm.String | false | true |
false
| 30 | N/A | N/A | N/A | N/A | | |
PhysicalPartitionTypeID | Edm.Int32 | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
PhysicalPartitionType Navigational Properties
No navigational properties
Verb(s) | Required Permission(s) | Link | Description |
---|
PollType Structural Properties
Property | Type | Nullable | Mandatory | Read-Only | String length | Min Value | Max Value | Precision | Max Dec Places | Is Only Date | Description |
---|
Id | Edm.Int32 | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
Name | Edm.String | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
PollType Navigational Properties
No navigational properties
Verb(s) | Required Permission(s) | Link | Description |
---|
Get | WS-ReadRoomPlan | | |
Patch | WS-ModifyRoomPlan | | |
Put | WS-ModifyRoomPlan | | |
Delete | WS-ModifyRoomPlan | | |
Post | WS-ModifyRoomPlan | | |
Polygon Structural Properties
Property | Type | Nullable | Mandatory | Read-Only | String length | Min Value | Max Value | Precision | Max Dec Places | Is Only Date | Description |
---|
BoundaryLength | Edm.Decimal | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
DisplayPropertiesID | Edm.Int32 | true | false |
true
| N/A | N/A | N/A | N/A | N/A | | |
FillType | Nlyte.Model.FillType | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
ID | Edm.Int32 | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
IsClosed | Edm.Boolean | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
LineWidth | Edm.Decimal | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
SaveAction | Nlyte.Model.SaveActionEnum | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
TopLeftOffsetAnchorID | Edm.Int32 | true | false |
true
| N/A | N/A | N/A | N/A | N/A | | |
TotalArea | Edm.Decimal | false | false |
true
| N/A | N/A | N/A | N/A | N/A | | |
Polygon Navigational Properties
Verb(s) | Required Permission(s) | Link | Description |
---|
Get | WS-ReadRoomPlan | | |
Patch | WS-ModifyRoomPlan | | |
Put | WS-ModifyRoomPlan | | |
Delete | WS-ModifyRoomPlan | | |
Post | WS-ModifyRoomPlan | | |
PolygonPoint Structural Properties
Property | Type | Nullable | Mandatory | Read-Only | String length | Min Value | Max Value | Precision | Max Dec Places | Is Only Date | Description |
---|
ID | Edm.Int32 | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
OrderIndex | Edm.Int32 | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
PolygonID | Edm.Int32 | true | false |
true
| N/A | N/A | N/A | N/A | N/A | | |
SaveAction | Nlyte.Model.SaveActionEnum | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
X | Edm.Decimal | false | false |
false
| N/A | 0 | 9999999.999 | 10 | 3 | | |
Y | Edm.Decimal | false | false |
false
| N/A | 0 | 9999999.999 | 10 | 3 | | |
PolygonPoint Navigational Properties
Verb(s) | Required Permission(s) | Link | Description |
---|
PowerMaterial Structural Properties
Property | Type | Nullable | Mandatory | Read-Only | String length | Min Value | Max Value | Precision | Max Dec Places | Is Only Date | Description |
---|
HasStaticSwitch | Edm.Boolean | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
InputCount | Edm.Int32 | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
InputPowerTypeID | Nlyte.Model.PowerTypeEnum | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | Power type: phased or direct current |
MaterialID | Edm.Int32 | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
RequiredInputs | Edm.Int32 | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
PowerMaterial Navigational Properties
PowerStrip Entity
: Asset
- Asset created from a material of type power strip, entity inheriting the Nlyte.Model.Asset entity
Verb(s) | Required Permission(s) | Link | Description |
---|
Get | WS-ReadPowerStrip | integration/api/odata/PowerStrips, integration/api/odata/PowerStrips({key}) | |
Delete | WS-ModifyPowerStrip | integration/api/odata/PowerStrips({key}) | |
Patch | WS-ModifyPowerStrip | integration/api/odata/PowerStrips({key}) | |
PostWithKey | WS-ModifyPowerStrip | integration/api/odata/PowerStrips({key}) | |
Post | WS-AddPowerStrip | integration/api/odata/PowerStrips | |
PowerStrip Structural Properties
Property | Type | Nullable | Mandatory | Read-Only | String length | Min Value | Max Value | Precision | Max Dec Places | Is Only Date | Description |
---|
AuditDate | Edm.DateTimeOffset | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
AuditStatusCorrect | Edm.Boolean | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
CurrentPowerFactor | Edm.Decimal | true | false |
true
| N/A | N/A | N/A | N/A | N/A | | Read-only property representing the percentage of power drawn by a PDD asset that is available to its consumers |
FreeOutlets | Edm.Int32 | false | false |
true
| N/A | N/A | N/A | N/A | N/A | | Read-only value, describing available outlets that can be used to create network connections |
IsMasterRedundancyDevice | Edm.Boolean | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | Value inserted by the user |
LastAuditorAccountID | Edm.Int32 | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
OutputCount | Edm.Int32 | false | false |
true
| N/A | N/A | N/A | N/A | N/A | | |
PowerFactorOverride | Edm.Decimal | true | false |
false
| N/A | 0 | 1 | 3 | 2 | | Value provided by the user, overriding the CurrentPowerFactor value |
RealtimePowerFactor | Edm.Decimal | true | false |
true
| N/A | N/A | N/A | N/A | N/A | | Read-only value. |
TotalPlugs | Edm.Int32 | false | false |
true
| N/A | N/A | N/A | N/A | N/A | | |
PowerStrip Navigational Properties
Verb(s) | Required Permission(s) | Link | Description |
---|
Get | WS-ReadPowerStripMaterial | integration/api/odata/PowerStripMaterials, integration/api/odata/PowerStripMaterials({key}) | |
Post | WS-AddPowerStripMaterial | integration/api/odata/PowerStripMaterials | |
PostWithKey | WS-ModifyPowerStripMaterial | integration/api/odata/PowerStripMaterials({key}) | |
Patch | WS-ModifyPowerStripMaterial | integration/api/odata/PowerStripMaterials({key}) | |
Delete | WS-ModifyPowerStripMaterial | integration/api/odata/PowerStripMaterials({key}) | |
PowerStripMaterial Structural Properties
Property | Type | Nullable | Mandatory | Read-Only | String length | Min Value | Max Value | Precision | Max Dec Places | Is Only Date | Description |
---|
CalculatedMaxKW | Edm.Decimal | true | false |
true
| N/A | N/A | N/A | N/A | N/A | | |
CordLength | Edm.Double | true | false |
false
| N/A | 0 | 99999 | 5 | 0 | | |
DistributorPowerFactor | Edm.Decimal | false | false |
true
| N/A | N/A | N/A | N/A | N/A | | |
InputPowerTypeID | Nlyte.Model.PowerTypeEnum | false | true |
false
| N/A | N/A | N/A | N/A | N/A | | Power type: phased or direct current |
MasterSwitch | Edm.Boolean | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
MaterialCategoryID | Edm.Int32 | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
MaxAmperage | Edm.Decimal | true | false |
false
| N/A | 0 | 99999.999 | 8 | 3 | | |
MaxVoltage | Edm.Decimal | true | false |
false
| N/A | 0 | 99999.999 | 8 | 3 | | |
OutletType | Edm.String | true | false |
false
| 50 | N/A | N/A | N/A | N/A | | |
PilotLight | Edm.Boolean | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
PlugType | Edm.String | true | false |
false
| 50 | N/A | N/A | N/A | N/A | | Property selected from the available types, available as lookups InputConnectorTypes |
RequiredPlugs | Edm.Int32 | false | true |
false
| N/A | N/A | N/A | N/A | N/A | | Value inserted by the user, while the material is in Planned status |
TotalOutlets | Edm.Int32 | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
TotalPlugs | Edm.Int32 | false | true |
false
| N/A | N/A | N/A | N/A | N/A | | Value inserted by the user, while the material is in Planned status |
UHeight | Edm.Int64 | false | false |
true
| N/A | N/A | N/A | N/A | N/A | | |
WorkableFootPrintFront | Edm.Double | false | false |
false
| N/A | 0 | 999999999999.9999 | 16 | 4 | | |
WorkableFootPrintHeight | Edm.Double | false | false |
false
| N/A | 0 | 999999999999.9999 | 16 | 4 | | |
WorkableFootPrintRear | Edm.Double | false | false |
false
| N/A | 0 | 999999999999.9999 | 16 | 4 | | |
PowerStripMaterial Navigational Properties
Verb(s) | Required Permission(s) | Link | Description |
---|
Get | WS-ReadProcess | integration/api/odata/Processes, integration/api/odata/Processes({key}) | |
Post | WS-AddProcess | integration/api/odata/Processes | |
Patch | WS-ModifyProcess | integration/api/odata/Processes({key}) | |
Put | WS-ModifyProcess | integration/api/odata/Processes({key}) | |
Process Structural Properties
Property | Type | Nullable | Mandatory | Read-Only | String length | Min Value | Max Value | Precision | Max Dec Places | Is Only Date | Description |
---|
AllLocationsAreValid | Edm.Boolean | false | false |
true
| N/A | N/A | N/A | N/A | N/A | | |
Category | Nlyte.Model.ProcessCategory | false | true |
false
| N/A | N/A | N/A | N/A | N/A | | |
DateCreated | Edm.DateTimeOffset | false | false |
true
| N/A | N/A | N/A | N/A | N/A | | |
DateLastUpdated | Edm.DateTimeOffset | false | false |
true
| N/A | N/A | N/A | N/A | N/A | | |
Description | Edm.String | true | false |
false
| 1000 | N/A | N/A | N/A | N/A | | |
DesignedByResourceID | Edm.Int32 | true | false |
true
| N/A | N/A | N/A | N/A | N/A | | |
ID | Edm.Int32 | false | false |
true
| N/A | N/A | N/A | N/A | N/A | | |
IsLatestVersion | Edm.Boolean | false | false |
true
| N/A | N/A | N/A | N/A | N/A | | |
LastUpdatedByResourceID | Edm.Int32 | true | false |
true
| N/A | N/A | N/A | N/A | N/A | | |
Name | Edm.String | false | true |
false
| 250 | N/A | N/A | N/A | N/A | | Process Name. This must be unique. |
PreventNameEditingAfterStart | Edm.Boolean | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
Status | Nlyte.Model.ProcessStatus | false | true |
true
| N/A | N/A | N/A | N/A | N/A | | |
TotalDurationInMinutes | Edm.Int64 | true | false |
true
| N/A | N/A | N/A | N/A | N/A | | |
Type | Nlyte.Model.ProcessType | false | true |
false
| N/A | N/A | N/A | N/A | N/A | | |
UntrustedLocationGroupId | Edm.Int32 | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
Version | Edm.Int32 | false | false |
true
| N/A | N/A | N/A | N/A | N/A | | |
Process Navigational Properties
Verb(s) | Required Permission(s) | Link | Description |
---|
ProcessForm Structural Properties
Property | Type | Nullable | Mandatory | Read-Only | String length | Min Value | Max Value | Precision | Max Dec Places | Is Only Date | Description |
---|
DisplayName | Edm.String | false | true |
false
| N/A | N/A | N/A | N/A | N/A | | |
FormID | Edm.Int32 | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
FormOrder | Edm.Int32 | false | false |
true
| N/A | N/A | N/A | N/A | N/A | | |
id | Edm.Int32 | false | false |
true
| N/A | N/A | N/A | N/A | N/A | | |
ProcessID | Edm.Int32 | true | false |
true
| N/A | N/A | N/A | N/A | N/A | | |
ProcessForm Navigational Properties
Verb(s) | Required Permission(s) | Link | Description |
---|
ProcessFormControl Structural Properties
Property | Type | Nullable | Mandatory | Read-Only | String length | Min Value | Max Value | Precision | Max Dec Places | Is Only Date | Description |
---|
FormControlID | Edm.Int32 | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
ID | Edm.Int32 | false | false |
true
| N/A | N/A | N/A | N/A | N/A | | |
IsEditable | Edm.Boolean | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
IsVisible | Edm.Boolean | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
ProcessID | Edm.Int32 | true | false |
true
| N/A | N/A | N/A | N/A | N/A | | |
ProcessFormControl Navigational Properties
Verb(s) | Required Permission(s) | Link | Description |
---|
Project Structural Properties
Property | Type | Nullable | Mandatory | Read-Only | String length | Min Value | Max Value | Precision | Max Dec Places | Is Only Date | Description |
---|
ActualEndDate | Edm.DateTimeOffset | true | false |
true
| N/A | N/A | N/A | N/A | N/A | IsOnlyDate | |
ActualStartDate | Edm.DateTimeOffset | true | false |
true
| N/A | N/A | N/A | N/A | N/A | IsOnlyDate | |
AutoAllocationEndDate | Edm.DateTimeOffset | true | false |
true
| N/A | N/A | N/A | N/A | N/A | | |
AutoAllocationStartDate | Edm.DateTimeOffset | true | false |
true
| N/A | N/A | N/A | N/A | N/A | | |
BusinessGroupID | Edm.Int32 | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
CreationDate | Edm.DateTimeOffset | true | false |
true
| N/A | N/A | N/A | N/A | N/A | | |
DefaultCabinetUsageID | Edm.Int32 | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
ExpectedEndDate | Edm.DateTimeOffset | false | false |
false
| N/A | N/A | N/A | N/A | N/A | IsOnlyDate | |
ExpectedStartDate | Edm.DateTimeOffset | false | false |
false
| N/A | N/A | N/A | N/A | N/A | IsOnlyDate | |
ProjectID | Edm.Int32 | false | false |
true
| N/A | N/A | N/A | N/A | N/A | | |
ProjectName | Edm.String | false | true |
false
| 40 | N/A | N/A | N/A | N/A | | |
ProjectNumber | Edm.Int32 | true | false |
true
| N/A | N/A | N/A | N/A | N/A | | |
ProjectStatus | Nlyte.Model.ProjectStatusEnum | true | |
false
| | | | | | | |
ProjectType | Nlyte.Model.ProjectTypeEnum | false | |
false
| | | | | | | |
Project Navigational Properties
Verb(s) | Required Permission(s) | Link | Description |
---|
ProjectAction Structural Properties
Property | Type | Nullable | Mandatory | Read-Only | String length | Min Value | Max Value | Precision | Max Dec Places | Is Only Date | Description |
---|
Detail | Edm.String | false | true |
false
| 30 | N/A | N/A | N/A | N/A | | Project action |
ProjectActionID | Edm.Int32 | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
ProjectAction Navigational Properties
No navigational properties
Verb(s) | Required Permission(s) | Link | Description |
---|
Key(s) |
---|
ProjectDependenciesID |
ProjectDependency Structural Properties
Property | Type | Nullable | Mandatory | Read-Only | String length | Min Value | Max Value | Precision | Max Dec Places | Is Only Date | Description |
---|
Order | Edm.Int32 | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
ProjectChildID | Edm.Int32 | true | false |
true
| N/A | N/A | N/A | N/A | N/A | | |
ProjectDependenciesID | Edm.Int32 | false | false |
true
| N/A | N/A | N/A | N/A | N/A | | |
ProjectParentID | Edm.Int32 | true | false |
true
| N/A | N/A | N/A | N/A | N/A | | |
ProjectDependency Navigational Properties
Verb(s) | Required Permission(s) | Link | Description |
---|
Get | WS-ReadChassis,WS-ReadServer,WS-ReadNetwork,WS-ReadPeripheral,WS-ReadServerHost,WS-ReadNetworkMaterial,WS-ReadChassisMaterial,WS-ReadPeripheralMaterial,WS-ReadServerMaterial | integration/api/odata/ProjectItems, integration/api/odata/ProjectItems({key}) | |
Post | WS-ReadChassis,WS-ReadServer,WS-ReadChassisMaterial,WS-ReadServerMaterial | integration/api/odata/ProjectItems | |
ProjectItem Structural Properties
Property | Type | Nullable | Mandatory | Read-Only | String length | Min Value | Max Value | Precision | Max Dec Places | Is Only Date | Description |
---|
AssetID | Edm.Int32 | true | false |
true
| N/A | N/A | N/A | N/A | N/A | | |
MaterialID | Edm.Int32 | true | false |
true
| N/A | N/A | N/A | N/A | N/A | | |
Order | Edm.Int32 | false | true |
false
| N/A | N/A | N/A | N/A | N/A | | |
ProjectID | Edm.Int32 | true | false |
true
| N/A | N/A | N/A | N/A | N/A | | |
ProjectItemAction | Nlyte.Model.ProjectItemActionEnum | false | |
false
| | | | | | | |
ProjectItemAllocateCriteriaID | Edm.Int32 | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
ProjectItemID | Edm.Int32 | false | false |
true
| N/A | N/A | N/A | N/A | N/A | | |
ProjectItemStatus | Nlyte.Model.ProjectItemStatusEnum | true | |
false
| | | | | | | |
TargetAssetID | Edm.Int32 | true | false |
true
| N/A | N/A | N/A | N/A | N/A | | Asset found after running the auto-allocation criteria against the item |
ProjectItem Navigational Properties
Verb(s) | Required Permission(s) | Link | Description |
---|
Get | WS-ReadCabinet,WS-ReadChassis,WS-ReadServer,WS-ReadNetwork,WS-ReadPeripheral,WS-ReadServerHost,WS-ReadNetworkMaterial,WS-ReadCabinetMaterial,WS-ReadChassisMaterial,WS-ReadPeripheralMaterial,WS-ReadServerMaterial | integration/api/odata/ProjectItemAllocateCriterias({key}), integration/api/odata/ProjectItemAllocateCriterias | |
Key(s) |
---|
ProjectItemAllocateCriteriaID |
ProjectItemAllocateCriteria Structural Properties
Property | Type | Nullable | Mandatory | Read-Only | String length | Min Value | Max Value | Precision | Max Dec Places | Is Only Date | Description |
---|
AirflowTypeID | Nlyte.Model.AirflowTypeEnum | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | Selected air flow, from the available values defined in the administration area |
AutoConnectToKvmSwitch | Edm.Boolean | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
AutoConnectToPatchPanels | Edm.Boolean | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
AutoConnectToPowerSupplies | Edm.Boolean | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
BusinessGroupID | Edm.Int32 | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
CabinetUsageID | Edm.Int32 | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
FindExactMatchForUSpace | Edm.Boolean | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
IncludeInAutoAllocation | Edm.Boolean | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
MountingTypeID | Nlyte.Model.MountingTypeEnum | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
PatchingNetworkSubTypeID | Nlyte.Model.NetworkSubTypeEnum | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
ProjectID | Edm.Int32 | true | false |
true
| N/A | N/A | N/A | N/A | N/A | | |
ProjectItemAllocateCriteriaID | Edm.Int32 | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
ProjectItemID | Edm.Int32 | false | false |
true
| N/A | N/A | N/A | N/A | N/A | | |
RequiredUHeight | Edm.Int32 | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
ReturnCabinetsLinkedToSelectedBusinessGroupOnly | Edm.Boolean | false | |
false
| | | | | | | |
TargetLocationGroupID | Edm.Int32 | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | Entity representing the location used for allocation. |
UseAirflow | Edm.Boolean | false | |
false
| | | | | | | |
UseBusinessGroups | Edm.Boolean | false | |
false
| | | | | | | |
UseCabinetUsage | Edm.Boolean | false | |
false
| | | | | | | |
UseCardConnections | Edm.Boolean | false | |
false
| | | | | | | |
UseCompatibleNetworks | Edm.Boolean | false | |
false
| | | | | | | |
UseDataType | Edm.Boolean | false | |
false
| | | | | | | |
UseDiversePower | Edm.Boolean | false | |
false
| | | | | | | |
UseKvmSwitch | Edm.Boolean | false | |
false
| | | | | | | |
UseMountingType | Edm.Boolean | false | |
false
| | | | | | | |
UsePatchingNetworkSubType | Edm.Boolean | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
UsePowerConnections | Edm.Boolean | false | |
false
| | | | | | | |
UseTotalHeat | Edm.Boolean | false | |
false
| | | | | | | |
UseTotalWeight | Edm.Boolean | false | |
false
| | | | | | | |
UseWarningPolicies | Edm.Boolean | false | |
false
| | | | | | | |
ProjectItemAllocateCriteria Navigational Properties
Verb(s) | Required Permission(s) | Link | Description |
---|
ProjectItemHistory Structural Properties
Property | Type | Nullable | Mandatory | Read-Only | String length | Min Value | Max Value | Precision | Max Dec Places | Is Only Date | Description |
---|
AssetID | Edm.Int32 | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
CabinetAssetID | Edm.Int32 | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
CabinetAssetNumber | Edm.Int32 | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
CabinetName | Edm.String | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
DuplicateLocationGroupName | Edm.String | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | The unique location name, having the name as a concatenation of last hierarchical location names. |
LocationGroupID | Edm.Int32 | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | Foreign key identifying the location |
MaterialName | Edm.String | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
MaterialNumber | Edm.Int32 | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
MaterialType | Edm.String | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
MaterialTypeID | Edm.Int32 | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
Name | Edm.String | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
Number | Edm.Int32 | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
OperationalStatus | Nlyte.Model.OperationalStatusEnum | false | |
false
| | | | | | | |
ProjectItemID | Edm.Int32 | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
ProjectItemStatus | Nlyte.Model.ProjectItemStatusEnum | true | |
false
| | | | | | | |
RecordStatus | Nlyte.Model.RecordStatusEnum | false | |
false
| | | | | | | |
UNumber | Edm.Int32 | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
ProjectItemHistory Navigational Properties
No navigational properties
Verb(s) | Required Permission(s) | Link | Description |
---|
ProjectPurpose Structural Properties
Property | Type | Nullable | Mandatory | Read-Only | String length | Min Value | Max Value | Precision | Max Dec Places | Is Only Date | Description |
---|
Detail | Edm.String | false | true |
false
| 30 | N/A | N/A | N/A | N/A | | Project purpose |
ProjectPurposeID | Edm.Int32 | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
ProjectPurpose Navigational Properties
No navigational properties
Verb(s) | Required Permission(s) | Link | Description |
---|
Provider Structural Properties
Property | Type | Nullable | Mandatory | Read-Only | String length | Min Value | Max Value | Precision | Max Dec Places | Is Only Date | Description |
---|
FriendlyName | Edm.String | true | false |
false
| 512 | N/A | N/A | N/A | N/A | | |
FullName | Edm.String | true | false |
false
| 1000 | N/A | N/A | N/A | N/A | | |
ID | Edm.Guid | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
LicenseName | Edm.String | true | false |
false
| 512 | N/A | N/A | N/A | N/A | | |
Provider Navigational Properties
No navigational properties
Verb(s) | Required Permission(s) | Link | Description |
---|
Get | WS-ReadRealtimeDataProvider | integration/api/odata/RealTimeDataProviders, integration/api/odata/RealTimeDataProviders({key}) | |
Delete | WS-ModifyRealtimeDataProvider | integration/api/odata/RealTimeDataProviders({key}) | |
Patch | WS-ModifyRealtimeDataProvider | integration/api/odata/RealTimeDataProviders({key}) | |
PostWithKey | WS-ModifyRealtimeDataProvider | | |
Post | WS-AddRealtimeDataProvider | integration/api/odata/RealTimeDataProviders | |
RealTimeDataProvider Structural Properties
Property | Type | Nullable | Mandatory | Read-Only | String length | Min Value | Max Value | Precision | Max Dec Places | Is Only Date | Description |
---|
Description | Edm.String | true | false |
false
| 512 | N/A | N/A | N/A | N/A | | |
Height | Edm.Int32 | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
LastUpdated | Edm.DateTimeOffset | true | false |
true
| N/A | N/A | N/A | N/A | N/A | | |
ProviderID | Edm.Int32 | false | false |
true
| N/A | N/A | N/A | N/A | N/A | | |
ShortName | Edm.String | true | false |
false
| 12 | N/A | N/A | N/A | N/A | | |
Width | Edm.Int32 | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
RealTimeDataProvider Navigational Properties
No navigational properties
Verb(s) | Required Permission(s) | Link | Description |
---|
Get | WS-ReadRealtimeInfo | integration/api/odata/RealTimeInfo, integration/api/odata/RealTimeInfo({key}) | |
Delete | WS-ModifyRealtimeInfo | integration/api/odata/RealTimeInfo({key}) | |
Patch | WS-ModifyRealtimeInfo | integration/api/odata/RealTimeInfo({key}) | |
PostWithKey | WS-ModifyRealtimeInfo | | |
Post | WS-AddRealtimeInfo | integration/api/odata/RealTimeInfo | |
RealTimeInfo Structural Properties
Property | Type | Nullable | Mandatory | Read-Only | String length | Min Value | Max Value | Precision | Max Dec Places | Is Only Date | Description |
---|
DefaultUnit | Edm.String | true | false |
false
| 10 | N/A | N/A | N/A | N/A | | |
DefaultUnitMultiplyFactor | Edm.Double | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
Description | Edm.String | true | false |
false
| 250 | N/A | N/A | N/A | N/A | | |
LogData | Edm.Boolean | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
Name | Edm.String | true | false |
false
| 50 | N/A | N/A | N/A | N/A | | |
RealtimeInfoID | Edm.Int32 | false | false |
true
| N/A | N/A | N/A | N/A | N/A | | |
RealTimeInfo Navigational Properties
No navigational properties
Verb(s) | Required Permission(s) | Link | Description |
---|
RealTimeValue Structural Properties
Property | Type | Nullable | Mandatory | Read-Only | String length | Min Value | Max Value | Precision | Max Dec Places | Is Only Date | Description |
---|
AssetId | Edm.Int32 | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
ConnectorNo | Edm.Int32 | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
ConnectorType | Edm.String | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
Name | Edm.String | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
Phase1Value | Edm.Decimal | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
Phase2Value | Edm.Decimal | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
Phase3Value | Edm.Decimal | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
Position | Edm.Int32 | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
ProviderId | Edm.Int32 | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
ProviderName | Edm.String | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
RecordedDateTime | Edm.DateTimeOffset | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
ThreePhaseRecordedDateTime | Edm.DateTimeOffset | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
Unit | Edm.String | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
UnitMultiplyFactor | Edm.Double | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
Value | Edm.Decimal | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
RealTimeValue Navigational Properties
No navigational properties
Receptacle Entity
: Asset
- Asset created from a material of type receptacle, entity inheriting the Nlyte.Model.Asset entity
Verb(s) | Required Permission(s) | Link | Description |
---|
Get | WS-ReadReceptacle | integration/api/odata/Receptacles, integration/api/odata/Receptacles({key}) | |
Patch | WS-ModifyReceptacle | integration/api/odata/Receptacles({key}) | |
PostWithKey | WS-ModifyReceptacle | integration/api/odata/Receptacles({key}) | |
Delete | WS-ModifyReceptacle | integration/api/odata/Receptacles({key}) | |
Post | WS-AddReceptacle | integration/api/odata/Receptacles | |
Receptacle Structural Properties
Property | Type | Nullable | Mandatory | Read-Only | String length | Min Value | Max Value | Precision | Max Dec Places | Is Only Date | Description |
---|
CurrentPowerFactor | Edm.Decimal | true | false |
true
| N/A | N/A | N/A | N/A | N/A | | Read-only property representing the percentage of power drawn by a PDD asset that is available to its consumers |
IsMasterRedundancyDevice | Edm.Boolean | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | Value inserted by the user |
IsUsable | Edm.Boolean | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
OutputCount | Edm.Int32 | false | false |
true
| N/A | N/A | N/A | N/A | N/A | | |
PhaseARegisterAddress | Edm.String | true | false |
false
| 255 | N/A | N/A | N/A | N/A | | |
PhaseBRegisterAddress | Edm.String | true | false |
false
| 255 | N/A | N/A | N/A | N/A | | |
PhaseCRegisterAddress | Edm.String | true | false |
false
| 255 | N/A | N/A | N/A | N/A | | |
PowerFactorOverride | Edm.Decimal | true | false |
false
| N/A | 0 | 1 | 3 | 2 | | Value provided by the user, overriding the CurrentPowerFactor value |
RealtimePowerFactor | Edm.Decimal | true | false |
true
| N/A | N/A | N/A | N/A | N/A | | Read-only value. |
WattsRegisterAddress | Edm.String | true | false |
false
| 255 | N/A | N/A | N/A | N/A | | |
Receptacle Navigational Properties
Verb(s) | Required Permission(s) | Link | Description |
---|
Get | WS-ReadReceptacleMaterial | integration/api/odata/ReceptacleMaterials, integration/api/odata/ReceptacleMaterials({key}) | |
Post | WS-AddReceptacleMaterial | integration/api/odata/ReceptacleMaterials | |
PostWithKey | WS-ModifyReceptacleMaterial | integration/api/odata/ReceptacleMaterials({key}) | |
Patch | WS-ModifyReceptacleMaterial | integration/api/odata/ReceptacleMaterials({key}) | |
Delete | WS-ModifyReceptacleMaterial | integration/api/odata/ReceptacleMaterials({key}) | |
ReceptacleMaterial Structural Properties
Property | Type | Nullable | Mandatory | Read-Only | String length | Min Value | Max Value | Precision | Max Dec Places | Is Only Date | Description |
---|
EarthHourPosition | Edm.Int32 | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
FrequencyRange | Edm.String | true | false |
false
| 30 | N/A | N/A | N/A | N/A | | |
InputPowerTypeID | Nlyte.Model.PowerTypeEnum | false | true |
false
| N/A | N/A | N/A | N/A | N/A | | Power type: phased or direct current |
MaterialCategoryID | Edm.Int32 | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
MaxAmperage | Edm.Decimal | true | false |
false
| N/A | 0 | 99999.999 | 8 | 3 | | |
MaxVoltage | Edm.Decimal | true | false |
false
| N/A | 0 | 99999.999 | 8 | 3 | | |
OutletType | Edm.String | true | false |
false
| 50 | N/A | N/A | N/A | N/A | | |
PinConfigurationID | Nlyte.Model.PinConfigurationEnum | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
TotalOutlets | Edm.Int32 | false | true |
false
| N/A | N/A | N/A | N/A | N/A | | |
UHeight | Edm.Int64 | false | false |
true
| N/A | N/A | N/A | N/A | N/A | | |
ReceptacleMaterial Navigational Properties
Verb(s) | Required Permission(s) | Link | Description |
---|
RecordListItem Structural Properties
No structural properties
RecordListItem Navigational Properties
No navigational properties
Verb(s) | Required Permission(s) | Link | Description |
---|
RecordType Structural Properties
Property | Type | Nullable | Mandatory | Read-Only | String length | Min Value | Max Value | Precision | Max Dec Places | Is Only Date | Description |
---|
Description | Edm.String | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
RecordTypeID | Edm.Int32 | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
RecordType Navigational Properties
Verb(s) | Required Permission(s) | Link | Description |
---|
RecycleAssetControl Structural Properties
No structural properties
RecycleAssetControl Navigational Properties
No navigational properties
Verb(s) | Required Permission(s) | Link | Description |
---|
RecycleAssetControlValue Structural Properties
Property | Type | Nullable | Mandatory | Read-Only | String length | Min Value | Max Value | Precision | Max Dec Places | Is Only Date | Description |
---|
ProcessedAssetIDs | Collection(Edm.Int32) | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
RecycleAssetControlValue Navigational Properties
No navigational properties
Verb(s) | Required Permission(s) | Link | Description |
---|
RenameAssetControl Structural Properties
No structural properties
RenameAssetControl Navigational Properties
No navigational properties
Verb(s) | Required Permission(s) | Link | Description |
---|
RenameAssetControlValue Structural Properties
No structural properties
RenameAssetControlValue Navigational Properties
No navigational properties
Verb(s) | Required Permission(s) | Link | Description |
---|
ReplaceFormResult Structural Properties
Property | Type | Nullable | Mandatory | Read-Only | String length | Min Value | Max Value | Precision | Max Dec Places | Is Only Date | Description |
---|
ID | Edm.Int32 | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
ReplaceFormResult Navigational Properties
Verb(s) | Required Permission(s) | Link | Description |
---|
Post | WS-AddForm | integration/api/odata/ReportingTags | |
ReportingTag Structural Properties
Property | Type | Nullable | Mandatory | Read-Only | String length | Min Value | Max Value | Precision | Max Dec Places | Is Only Date | Description |
---|
ID | Edm.Int32 | false | false |
true
| N/A | N/A | N/A | N/A | N/A | | |
Name | Edm.String | false | true |
false
| 50 | N/A | N/A | N/A | N/A | | |
ReportingTag Navigational Properties
No navigational properties
Verb(s) | Required Permission(s) | Link | Description |
---|
Resource Structural Properties
Property | Type | Nullable | Mandatory | Read-Only | String length | Min Value | Max Value | Precision | Max Dec Places | Is Only Date | Description |
---|
ClientUserGUID | Edm.String | true | false |
false
| 100 | N/A | N/A | N/A | N/A | | |
Company | Edm.String | true | false |
false
| 50 | N/A | N/A | N/A | N/A | | |
CompanyPhoneNumber | Edm.String | true | false |
false
| 50 | N/A | N/A | N/A | N/A | | |
CultureID | Edm.Int32 | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
Department | Edm.String | true | false |
false
| 50 | N/A | N/A | N/A | N/A | | |
DepartmentPhoneNumber | Edm.String | true | false |
false
| 50 | N/A | N/A | N/A | N/A | | |
Email | Edm.String | true | false |
false
| 254 | N/A | N/A | N/A | N/A | | |
Forename | Edm.String | false | true |
false
| 50 | N/A | N/A | N/A | N/A | | |
FullName | Edm.String | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
ManagerResourceID | Edm.Int32 | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
MeasurementSystemID | Edm.Int32 | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
Middlename | Edm.String | false | true |
false
| 50 | N/A | N/A | N/A | N/A | | |
MobileNumber | Edm.String | true | false |
false
| 50 | N/A | N/A | N/A | N/A | | |
PhoneNumber | Edm.String | false | true |
false
| 50 | N/A | N/A | N/A | N/A | | |
ResourceID | Edm.Int32 | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
RFIDCardID | Edm.String | true | false |
false
| 50 | N/A | N/A | N/A | N/A | | |
Surname | Edm.String | false | true |
false
| 50 | N/A | N/A | N/A | N/A | | |
TimeZone | Edm.Double | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
Title | Edm.String | true | false |
false
| 10 | N/A | N/A | N/A | N/A | | |
Resource Navigational Properties
Verb(s) | Required Permission(s) | Link | Description |
---|
Get | WS-ReadRoomPlan | integration/api/odata/Rooms, integration/api/odata/Rooms({key}) | |
Patch | WS-ModifyRoomPlan | | |
Put | WS-ModifyRoomPlan | integration/api/odata/Rooms({key}) | |
Post | WS-ModifyRoomPlan | | |
Room Structural Properties
Property | Type | Nullable | Mandatory | Read-Only | String length | Min Value | Max Value | Precision | Max Dec Places | Is Only Date | Description |
---|
Alias | Edm.String | true | false |
true
| 255 | N/A | N/A | N/A | N/A | | |
CoolingLimit | Edm.Decimal | true | false |
false
| N/A | 0 | 9999999.999 | 10 | 3 | | |
CoolingMaximum | Edm.Decimal | true | false |
false
| N/A | 0 | 9999999.999 | 10 | 3 | | |
CoolingThreshold | Edm.Decimal | true | false |
false
| N/A | 0 | 9999999.999 | 10 | 3 | | |
GridId | Edm.Int32 | true | false |
true
| N/A | N/A | N/A | N/A | N/A | | |
HeatLimit | Edm.Decimal | true | false |
false
| N/A | 0 | 9999999.999 | 10 | 3 | | |
HeatMaximum | Edm.Decimal | true | false |
false
| N/A | 0 | 9999999.999 | 10 | 3 | | |
HeatThreshold | Edm.Decimal | true | false |
false
| N/A | 0 | 9999999.999 | 10 | 3 | | |
Image | Edm.String | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
NominalPower | Edm.Decimal | true | false |
false
| N/A | 0 | 9999999.999 | 10 | 3 | | |
WeightLimit | Edm.Decimal | true | false |
false
| N/A | 0 | 9999999.9999 | 11 | 4 | | |
WeightMaximum | Edm.Decimal | true | false |
false
| N/A | 0 | 9999999.9999 | 11 | 4 | | |
WeightThreshold | Edm.Decimal | true | false |
false
| N/A | 0 | 9999999.9999 | 11 | 4 | | |
Room Navigational Properties
Verb(s) | Required Permission(s) | Link | Description |
---|
Get | WS-ReadRoomPlan | | |
Patch | WS-ModifyRoomPlan | | |
Put | WS-ModifyRoomPlan | | |
Post | WS-ModifyRoomPlan | | |
RoomDrawingInfo Structural Properties
Property | Type | Nullable | Mandatory | Read-Only | String length | Min Value | Max Value | Precision | Max Dec Places | Is Only Date | Description |
---|
AmbientTemperature | Edm.Decimal | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
CavityHeight | Edm.Decimal | false | false |
false
| N/A | 0 | 99999.9 | 14 | 4 | | |
CavityMaterial | Nlyte.Model.FloorPlannerMaterial | true | |
false
| | | | | | | |
CeilingCavityHeight | Edm.Decimal | false | false |
false
| N/A | 0 | 99999.9 | 14 | 4 | | |
ContainsContent | Edm.Boolean | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
FloorCavityHeight | Edm.Decimal | false | false |
false
| N/A | 0 | 99999.9 | 14 | 4 | | |
FloorId | Edm.Int32 | true | false |
true
| N/A | N/A | N/A | N/A | N/A | | |
FloorLocationGroupId | Edm.Int32 | false | false |
true
| N/A | N/A | N/A | N/A | N/A | | |
ID | Edm.Int32 | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
Latitude | Edm.Decimal | true | false |
true
| N/A | N/A | N/A | N/A | N/A | | |
Length | Edm.Decimal | false | false |
false
| N/A | 0 | 9999999.9 | 14 | 4 | | |
LocationGroupID | Edm.Int32 | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
LocationPurpose | Edm.String | true | false |
true
| 255 | N/A | N/A | N/A | N/A | | |
Longitude | Edm.Decimal | true | false |
true
| N/A | N/A | N/A | N/A | N/A | | |
Name | Edm.String | true | false |
true
| 50 | N/A | N/A | N/A | N/A | | |
SaveAction | Nlyte.Model.SaveActionEnum | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
TotalAreaOverride | Edm.Decimal | true | false |
false
| N/A | 0 | 1000000000000000 | 19 | 4 | | |
UsedArea | Edm.Decimal | false | false |
true
| N/A | N/A | N/A | N/A | N/A | | |
Width | Edm.Decimal | false | false |
false
| N/A | 0 | 9999999.9 | 14 | 4 | | |
X | Edm.Decimal | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
Y | Edm.Decimal | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
RoomDrawingInfo Navigational Properties
Verb(s) | Required Permission(s) | Link | Description |
---|
Get | WS-ReadRoomPlan | | |
Patch | WS-ModifyRoomPlan | | |
Put | WS-ModifyRoomPlan | | |
Delete | WS-ModifyRoomPlan | | |
Post | WS-ModifyRoomPlan | | |
RoomItem Structural Properties
Property | Type | Nullable | Mandatory | Read-Only | String length | Min Value | Max Value | Precision | Max Dec Places | Is Only Date | Description |
---|
DisplayPropertiesID | Edm.Int32 | true | false |
true
| N/A | N/A | N/A | N/A | N/A | | |
ID | Edm.Int32 | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
LayerID | Edm.Int32 | true | true |
false
| N/A | N/A | N/A | N/A | N/A | | |
LocationGroupID | Edm.Int32 | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
MirrorX | Edm.Boolean | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
MirrorY | Edm.Boolean | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
Rotation | Edm.Int32 | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
SaveAction | Nlyte.Model.SaveActionEnum | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
TemplateID | Edm.Int32 | true | false |
true
| N/A | N/A | N/A | N/A | N/A | | The associated template |
X | Edm.Decimal | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
Y | Edm.Decimal | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
Z | Edm.Decimal | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
RoomItem Navigational Properties
Verb(s) | Required Permission(s) | Link | Description |
---|
RoomItemAsset Structural Properties
Property | Type | Nullable | Mandatory | Read-Only | String length | Min Value | Max Value | Precision | Max Dec Places | Is Only Date | Description |
---|
AssetID | Edm.Int32 | false | true |
false
| N/A | N/A | N/A | N/A | N/A | | |
AssetName | Edm.String | true | false |
true
| N/A | N/A | N/A | N/A | N/A | | |
AssetNumber | Edm.Int32 | false | false |
true
| N/A | N/A | N/A | N/A | N/A | | |
CachedGridRefOffsetX | Edm.Decimal | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
CachedGridRefOffsetY | Edm.Decimal | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
FootPrintBack | Edm.Decimal | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
FootPrintFront | Edm.Decimal | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
FootPrintLeft | Edm.Decimal | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
FootPrintRight | Edm.Decimal | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
GridReferenceColumn | Edm.String | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | Grid reference information, defined in the room planner |
GridReferenceRow | Edm.String | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | Grid reference information, defined in the room planner |
HeatingLimit | Edm.Double | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
HeatThreshold | Edm.Double | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
InternalRefPointX | Edm.Decimal | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
InternalRefPointY | Edm.Decimal | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
Length | Edm.Double | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
MaterialSubtypeId | Edm.Int32 | true | false |
true
| N/A | N/A | N/A | N/A | N/A | | |
MaterialType | Edm.String | true | false |
true
| N/A | N/A | N/A | N/A | N/A | | |
MaterialTypeId | Edm.Int32 | false | false |
true
| N/A | N/A | N/A | N/A | N/A | | |
OperationalStatus | Nlyte.Model.OperationalStatusEnum | false | false |
true
| N/A | N/A | N/A | N/A | N/A | | |
RecordStatus | Nlyte.Model.RecordStatusEnum | false | false |
true
| N/A | N/A | N/A | N/A | N/A | | |
WeightLimit | Edm.Double | true | false |
false
| N/A | 0 | 99999999999999.9999 | 18 | 4 | | |
WeightMaximum | Edm.Double | true | false |
false
| N/A | 0 | 99999999999999.9999 | 18 | 4 | | |
WeightThreshold | Edm.Double | true | false |
false
| N/A | 0 | 99999999999999.9999 | 18 | 4 | | |
Width | Edm.Double | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
WorkableFootPrintFront | Edm.Double | false | false |
true
| N/A | N/A | N/A | N/A | N/A | | |
WorkableFootPrintLeft | Edm.Double | false | false |
true
| N/A | N/A | N/A | N/A | N/A | | |
WorkableFootPrintRear | Edm.Double | false | false |
true
| N/A | N/A | N/A | N/A | N/A | | |
WorkableFootPrintRight | Edm.Double | false | false |
true
| N/A | N/A | N/A | N/A | N/A | | |
RoomItemAsset Navigational Properties
No navigational properties
Verb(s) | Required Permission(s) | Link | Description |
---|
RoomItemSimple Structural Properties
Property | Type | Nullable | Mandatory | Read-Only | String length | Min Value | Max Value | Precision | Max Dec Places | Is Only Date | Description |
---|
Length | Edm.Double | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
Name | Edm.String | true | true |
false
| 250 | N/A | N/A | N/A | N/A | | |
RoomItemCategoryId | Edm.Int32 | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
Width | Edm.Double | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
RoomItemSimple Navigational Properties
No navigational properties
Verb(s) | Required Permission(s) | Link | Description |
---|
Get | WS-ReadRoomPlan | | |
Patch | WS-ModifyRoomPlan | | |
Put | WS-ModifyRoomPlan | | |
Delete | WS-ModifyRoomPlan | | |
Post | WS-ModifyRoomPlan | | |
RoomLayer Structural Properties
Property | Type | Nullable | Mandatory | Read-Only | String length | Min Value | Max Value | Precision | Max Dec Places | Is Only Date | Description |
---|
ContentChanged | Edm.Boolean | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | Allows changes to items (RoomItems, Areas, Measurements, Walls, Zones) within a Locked or Invisible Layer |
RoomId | Edm.Int32 | true | false |
true
| N/A | N/A | N/A | N/A | N/A | | |
RoomLayer Navigational Properties
Verb(s) | Required Permission(s) | Link | Description |
---|
Get | WS-ReadPDUMaterial | integration/api/odata/RPPPDUMaterials, integration/api/odata/RPPPDUMaterials({key}) | |
Post | WS-AddPDUMaterial | integration/api/odata/RPPPDUMaterials | |
PostWithKey | WS-ModifyPDUMaterial | | |
Patch | WS-ModifyPDUMaterial | integration/api/odata/RPPPDUMaterials({key}) | |
Delete | WS-ModifyPDUMaterial | integration/api/odata/RPPPDUMaterials({key}) | |
RPPPDUMaterial Structural Properties
No structural properties
RPPPDUMaterial Navigational Properties
No navigational properties
Verb(s) | Required Permission(s) | Link | Description |
---|
Scheme Structural Properties
Property | Type | Nullable | Mandatory | Read-Only | String length | Min Value | Max Value | Precision | Max Dec Places | Is Only Date | Description |
---|
Label | Edm.String | false | true |
false
| 256 | N/A | N/A | N/A | N/A | | |
SchemeID | Edm.Int32 | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
Scheme Navigational Properties
Verb(s) | Required Permission(s) | Link | Description |
---|
SchemeColour Structural Properties
Property | Type | Nullable | Mandatory | Read-Only | String length | Min Value | Max Value | Precision | Max Dec Places | Is Only Date | Description |
---|
Colour | Edm.String | false | true |
false
| 20 | N/A | N/A | N/A | N/A | | |
ColourID | Edm.Int32 | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
Result | Edm.Int32 | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
SchemeID | Edm.Int32 | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
SchemeColour Navigational Properties
Server Entity
: Asset
- Asset created from a material of type server, entity inheriting the Nlyte.Model.Asset entity
Verb(s) | Required Permission(s) | Link | Description |
---|
Get | WS-ReadServer | integration/api/odata/Servers, integration/api/odata/Servers({key}) | |
Patch | WS-ModifyServer | integration/api/odata/Servers({key}) | |
PostWithKey | WS-ModifyServer | integration/api/odata/Servers({key}) | |
Delete | WS-ModifyServer | integration/api/odata/Servers({key}) | |
Post | WS-AddServer | integration/api/odata/Servers | |
Server Structural Properties
Property | Type | Nullable | Mandatory | Read-Only | String length | Min Value | Max Value | Precision | Max Dec Places | Is Only Date | Description |
---|
AuditDate | Edm.DateTimeOffset | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
AuditStatusCorrect | Edm.Boolean | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
ChassisMountedAssetMapID | Edm.Int32 | true | false |
true
| N/A | N/A | N/A | N/A | N/A | | |
FQDN | Edm.String | true | false |
false
| 255 | N/A | N/A | N/A | N/A | | |
HardwareSupportWeighting | Edm.Double | true | false |
true
| N/A | N/A | N/A | N/A | N/A | | |
LastAuditorAccountID | Edm.Int32 | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
ManagementSoftwareID | Edm.Int32 | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
OperatingSystemID | Edm.Int32 | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
ProjectID | Edm.Int32 | true | |
false
| | | | | | | |
StrategyID | Edm.Int32 | true | |
false
| | | | | | | |
TotalPlugs | Edm.Int32 | false | false |
true
| N/A | N/A | N/A | N/A | N/A | | |
TotalSystemSpace | Edm.Int32 | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
TrancheNumber | Edm.Int32 | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
Server Navigational Properties
Verb(s) | Required Permission(s) | Link | Description |
---|
Get | WS-ReadServerHost | integration/api/odata/ServerHosts, integration/api/odata/ServerHosts({key}) | |
Patch | WS-ModifyServerHost | integration/api/odata/ServerHosts({key}) | |
PostWithKey | WS-ModifyServerHost | integration/api/odata/ServerHosts({key}) | |
Delete | WS-ModifyServerHost | integration/api/odata/ServerHosts({key}) | |
Post | WS-AddServerHost | integration/api/odata/ServerHosts | |
ServerHost Structural Properties
Property | Type | Nullable | Mandatory | Read-Only | String length | Min Value | Max Value | Precision | Max Dec Places | Is Only Date | Description |
---|
Alias | Edm.String | true | false |
false
| 30 | N/A | N/A | N/A | N/A | | |
ApprovalGroup | Edm.String | true | false |
false
| 60 | N/A | N/A | N/A | N/A | | |
AssignmentGroup | Edm.String | true | false |
false
| 60 | N/A | N/A | N/A | N/A | | |
AvailabilityZone | Edm.String | true | false |
false
| 250 | N/A | N/A | N/A | N/A | | |
BusinessUnit | Edm.String | true | false |
false
| 60 | N/A | N/A | N/A | N/A | | |
ChangeControl | Edm.String | true | false |
false
| 60 | N/A | N/A | N/A | N/A | | |
Cluster | Edm.String | true | false |
false
| 50 | N/A | N/A | N/A | N/A | | |
ClusterVIP | Edm.String | true | false |
false
| 50 | N/A | N/A | N/A | N/A | | |
Comments | Edm.String | true | false |
false
| 800 | N/A | N/A | N/A | N/A | | |
CostCenter | Edm.String | true | false |
false
| 255 | N/A | N/A | N/A | N/A | | |
CPUAllocated | Edm.Double | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
CreationDate | Edm.DateTimeOffset | true | false |
true
| N/A | N/A | N/A | N/A | N/A | IsOnlyDate | |
Criticality | Edm.String | true | false |
false
| 60 | N/A | N/A | N/A | N/A | | |
DataSize | Edm.Double | false | false |
false
| N/A | 0 | 99999999999.99 | 13 | 2 | | |
DBBackup | Edm.String | true | false |
false
| 60 | N/A | N/A | N/A | N/A | | |
DiskAllocated | Edm.Double | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
EngineeringDomain | Edm.String | true | false |
false
| 60 | N/A | N/A | N/A | N/A | | |
FunctionalUseID | Edm.Int32 | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | Functional Usage defined in the administration area |
HasRemoteAccess | Edm.Boolean | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
HostGroup | Edm.String | true | false |
false
| 60 | N/A | N/A | N/A | N/A | | |
HostName | Edm.String | true | true |
false
| 80 | N/A | N/A | N/A | N/A | | |
HostNumber | Edm.Int32 | true | false |
true
| N/A | N/A | N/A | N/A | N/A | | |
InstanceStatus | Edm.String | true | false |
false
| 250 | N/A | N/A | N/A | N/A | | |
InstanceType | Edm.String | true | false |
false
| 250 | N/A | N/A | N/A | N/A | | |
IsVirtual | Edm.Boolean | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
LastAssetExplorerScanDate | Edm.DateTimeOffset | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
LeaderName | Edm.String | true | false |
false
| 250 | N/A | N/A | N/A | N/A | | |
LocationGroupID | Edm.Int32 | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | Foreign key identifying the host location |
LogicalPartitionTypeID | Edm.Int32 | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
MemoryAllocated | Edm.Double | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
MonthlyHostingCost | Edm.Decimal | true | false |
false
| N/A | 0 | 9999999999.9999 | 14 | 4 | | |
OperatingSystemSoftwareID | Edm.Int32 | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
OperationalDate | Edm.DateTimeOffset | true | false |
false
| N/A | N/A | N/A | N/A | N/A | IsOnlyDate | |
OperationalSupportWeightingPercent | Edm.Byte | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
OperationalUseID | Edm.Int32 | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | Operational Usage defined in the administration area |
OSBackup | Edm.String | true | false |
false
| 60 | N/A | N/A | N/A | N/A | | |
PhysicalPartitionID | Edm.Int32 | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | Logical partition defined in the administration area, associated to the current host on the parent equipment configuration |
PONumber | Edm.String | true | false |
false
| 255 | N/A | N/A | N/A | N/A | | |
PrimaryOwner | Edm.String | true | false |
false
| 60 | N/A | N/A | N/A | N/A | | |
PRNumber | Edm.String | true | false |
false
| 255 | N/A | N/A | N/A | N/A | | |
RecordStatus | Nlyte.Model.RecordStatusEnum | false | true |
false
| N/A | N/A | N/A | N/A | N/A | | |
Regulatory | Edm.Boolean | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
Risk | Edm.String | true | false |
false
| 60 | N/A | N/A | N/A | N/A | | |
SAPAssetNumber | Edm.String | true | false |
false
| 255 | N/A | N/A | N/A | N/A | | |
SecondaryOwner | Edm.String | true | false |
false
| 60 | N/A | N/A | N/A | N/A | | |
SerialUUID | Edm.String | true | false |
false
| 150 | N/A | N/A | N/A | N/A | | Serial UUID |
ServerAssetID | Edm.Int32 | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
ServerHostComplianceID | Edm.Int32 | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
ServerHostID | Edm.Int32 | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
ServerHostOperationalStatusID | Nlyte.Model.OperationalStatusEnum | false | true |
false
| N/A | N/A | N/A | N/A | N/A | | Reflects the current state and/or planned future state or the host. Together with the Record Status, they give the user the exact life-cycle status. |
ServiceLeaders | Edm.String | true | false |
false
| 250 | N/A | N/A | N/A | N/A | | |
SubStatusID | Edm.Int32 | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | Sub-status defined in the administration area. |
Tier | Edm.String | true | false |
false
| 60 | N/A | N/A | N/A | N/A | | |
UtilisationPercent | Edm.Byte | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
VMCreationDateTime | Edm.DateTimeOffset | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
VMIPAddress | Edm.String | true | false |
false
| 15 | N/A | N/A | N/A | N/A | | |
VMLastMoveDateTime | Edm.DateTimeOffset | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
VMLastUpdateDateTime | Edm.DateTimeOffset | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | VM Last Update Datetime |
VMName | Edm.String | true | false |
false
| 250 | N/A | N/A | N/A | N/A | | |
ServerHost Navigational Properties
Verb(s) | Required Permission(s) | Link | Description |
---|
Get | WS-ReadServerHostBusinessGroupMap | | |
Patch | WS-ModifyServerHostBusinessGroupMap | | |
Delete | WS-ModifyServerHostBusinessGroupMap | | |
Post | WS-AddServerHostBusinessGroupMap | | |
PostWithKey | WS-ModifyServerHostBusinessGroupMap | | |
ServerHostBusinessGroupMap Structural Properties
Property | Type | Nullable | Mandatory | Read-Only | String length | Min Value | Max Value | Precision | Max Dec Places | Is Only Date | Description |
---|
BusinessGroupID | Edm.Int32 | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
BusinessGroupName | Edm.String | true | false |
false
| 255 | N/A | N/A | N/A | N/A | | |
BusinessGroupNumber | Edm.Int32 | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
ColourIndex | Edm.Int32 | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
CultureID | Edm.Int32 | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
Description | Edm.String | true | false |
false
| 255 | N/A | N/A | N/A | N/A | | |
EmailAddress | Edm.String | true | false |
false
| 254 | N/A | N/A | N/A | N/A | | |
ID | Edm.Int32 | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
OwnershipPercentage | Edm.Int32 | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
ParentBusinessGroupID | Edm.Int32 | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
RecordStatus | Edm.Int32 | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
ServerHostID | Edm.Int32 | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
TelephoneNumber | Edm.String | true | false |
false
| 30 | N/A | N/A | N/A | N/A | | |
ServerHostBusinessGroupMap Navigational Properties
Verb(s) | Required Permission(s) | Link | Description |
---|
Key(s) |
---|
ServerHostComplianceID |
ServerHostCompliance Structural Properties
Property | Type | Nullable | Mandatory | Read-Only | String length | Min Value | Max Value | Precision | Max Dec Places | Is Only Date | Description |
---|
Detail | Edm.String | false | true |
false
| 50 | N/A | N/A | N/A | N/A | | Server host compliance |
ServerHostComplianceID | Edm.Int32 | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
ServerHostCompliance Navigational Properties
No navigational properties
Verb(s) | Required Permission(s) | Link | Description |
---|
Get | WS-ReadServerHostIPAddressMap | | |
Patch | WS-ModifyServerHostIPAddressMap | | |
Delete | WS-ModifyServerHostIPAddressMap | | |
Post | WS-AddServerHostIPAddressMap | | |
PostWithKey | WS-ModifyServerHostIPAddressMap | | |
Key(s) |
---|
ServerHostIPAddressMapID |
ServerHostIPAddressMap Structural Properties
Property | Type | Nullable | Mandatory | Read-Only | String length | Min Value | Max Value | Precision | Max Dec Places | Is Only Date | Description |
---|
IPAddressID | Edm.Int32 | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
ServerHostID | Edm.Int32 | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
ServerHostIPAddressMapID | Edm.Int32 | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
ServerHostIPAddressMap Navigational Properties
Verb(s) | Required Permission(s) | Link | Description |
---|
Get | WS-ReadHostSoftwareMap | | |
Post | WS-AddHostSoftwareMap | | |
Patch | WS-ModifyHostSoftwareMap | | |
PostWithKey | WS-ModifyHostSoftwareMap | | |
Delete | WS-ModifyHostSoftwareMap | | |
Key(s) |
---|
ServerHostSoftwareMapID |
ServerHostSoftwareMap Structural Properties
Property | Type | Nullable | Mandatory | Read-Only | String length | Min Value | Max Value | Precision | Max Dec Places | Is Only Date | Description |
---|
IsManagementSoftware | Edm.Boolean | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
IsOperatingSystem | Edm.Boolean | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
IsWebApplication | Edm.Boolean | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
RecordStatus | Edm.Byte | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
ServerHostID | Edm.Int32 | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
ServerHostSoftwareMapID | Edm.Int32 | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
SoftwareID | Edm.Int32 | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
SoftwareManufacturerID | Edm.Int32 | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | The manufacturer ID, used from the predefined list of manufacturers. |
SoftwareName | Edm.String | true | false |
false
| 100 | N/A | N/A | N/A | N/A | | |
SoftwareNumber | Edm.Int32 | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
SoftwareTypeID | Edm.Int32 | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
Version | Edm.String | true | false |
false
| 30 | N/A | N/A | N/A | N/A | | |
ServerHostSoftwareMap Navigational Properties
Verb(s) | Required Permission(s) | Link | Description |
---|
Get | WS-ReadServerHostSupportGroupMap | | |
Patch | WS-ModifyServerHostSupportGroupMap | | |
Delete | WS-ModifyServerHostSupportGroupMap | | |
Post | WS-AddServerHostSupportGroupMap | | |
PostWithKey | WS-ModifyServerHostSupportGroupMap | | |
ServerHostSupportGroupMap Structural Properties
Property | Type | Nullable | Mandatory | Read-Only | String length | Min Value | Max Value | Precision | Max Dec Places | Is Only Date | Description |
---|
ColourIndex | Edm.Int32 | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
CultureID | Edm.Int32 | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
Description | Edm.String | true | false |
false
| 255 | N/A | N/A | N/A | N/A | | |
EmailAddress | Edm.String | true | false |
false
| 254 | N/A | N/A | N/A | N/A | | |
ID | Edm.Int32 | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
ParentSupportGroupID | Edm.Int32 | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
RecordStatus | Edm.Int32 | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
ServerHostID | Edm.Int32 | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
SupportGroupID | Edm.Int32 | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
SupportGroupName | Edm.String | true | false |
false
| 255 | N/A | N/A | N/A | N/A | | |
SupportGroupNumber | Edm.Int32 | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
SupportPercentage | Edm.Int32 | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
TelephoneNumber | Edm.String | true | false |
false
| 30 | N/A | N/A | N/A | N/A | | |
ServerHostSupportGroupMap Navigational Properties
Verb(s) | Required Permission(s) | Link | Description |
---|
Get | WS-ReadServerMaterial | integration/api/odata/ServerMaterials, integration/api/odata/ServerMaterials({key}) | |
Post | WS-AddServerMaterial | integration/api/odata/ServerMaterials | |
PostWithKey | WS-ModifyServerMaterial | integration/api/odata/ServerMaterials({key}) | |
Patch | WS-ModifyServerMaterial | integration/api/odata/ServerMaterials({key}) | |
Delete | WS-ModifyServerMaterial | integration/api/odata/ServerMaterials({key}) | |
ServerMaterial Structural Properties
Property | Type | Nullable | Mandatory | Read-Only | String length | Min Value | Max Value | Precision | Max Dec Places | Is Only Date | Description |
---|
CalculatedMpafPowerConsumption | Edm.Decimal | true | false |
true
| N/A | N/A | N/A | N/A | N/A | | Read-only property, value provided by the service based on the PublishedPowerConsumption and the MpafOverride |
ConsumerPowerFactor | Edm.Decimal | false | false |
true
| N/A | N/A | N/A | N/A | N/A | | Read-only property representing the percentage of power drawn by a PDD material that is available to its asset consumers |
MountingTypeID | Nlyte.Model.MountingTypeEnum | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
MpafOverride | Edm.Decimal | true | false |
false
| N/A | 0.001 | 999 | 6 | 3 | | Value inserted by the user, while the material is in Planned status |
NumberOfColumns | Edm.Int32 | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
NumberOfRows | Edm.Int32 | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
UHeight | Edm.Int64 | false | false |
true
| N/A | N/A | N/A | N/A | N/A | | |
ServerMaterial Navigational Properties
Verb(s) | Required Permission(s) | Link | Description |
---|
Get | WS-ReadServiceRequest | integration/api/odata/ServiceRequests, integration/api/odata/ServiceRequests({key}) | |
Post | WS-AddServiceRequest | integration/api/odata/ServiceRequests | |
Patch | WS-ModifyServiceRequest | integration/api/odata/ServiceRequests({key}) | |
Put | WS-ModifyServiceRequest | integration/api/odata/ServiceRequests({key}) | |
ServiceRequest Structural Properties
Property | Type | Nullable | Mandatory | Read-Only | String length | Min Value | Max Value | Precision | Max Dec Places | Is Only Date | Description |
---|
AgingInMins | Edm.Int64 | true | false |
true
| N/A | N/A | N/A | N/A | N/A | | |
ChargeToAssigneeID | Edm.Int32 | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
ChargeToGroupsOfResourceID | Edm.Int32 | true | false |
true
| N/A | N/A | N/A | N/A | N/A | | |
DateAgingLastUpdated | Edm.DateTimeOffset | true | false |
true
| N/A | N/A | N/A | N/A | N/A | | |
DateClosed | Edm.DateTimeOffset | true | false |
true
| N/A | N/A | N/A | N/A | N/A | | |
DateExpectedClosing | Edm.DateTimeOffset | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
DateRequested | Edm.DateTimeOffset | false | false |
true
| N/A | N/A | N/A | N/A | N/A | | |
FileCount | Edm.Int32 | false | false |
true
| N/A | N/A | N/A | N/A | N/A | | |
HasIntegrationActivity | Edm.Boolean | false | false |
true
| N/A | N/A | N/A | N/A | N/A | | |
ID | Edm.Int32 | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
IsNew | Edm.Boolean | false | false |
true
| N/A | N/A | N/A | N/A | N/A | | |
IsOverdue | Edm.Boolean | false | false |
true
| N/A | N/A | N/A | N/A | N/A | | |
IssueCount | Edm.Int32 | false | false |
true
| N/A | N/A | N/A | N/A | N/A | | |
Name | Edm.String | false | true |
false
| 500 | N/A | N/A | N/A | N/A | | |
NoteCount | Edm.Int32 | false | false |
true
| N/A | N/A | N/A | N/A | N/A | | |
Priority | Nlyte.Model.Priority | false | true |
false
| N/A | N/A | N/A | N/A | N/A | | |
PriorityFocusID | Nlyte.Model.PriorityFocus | false | false |
true
| N/A | N/A | N/A | N/A | N/A | | |
ProcessID | Edm.Int32 | true | true |
false
| N/A | N/A | N/A | N/A | N/A | | |
ReferenceNumber | Edm.Int32 | false | false |
true
| N/A | N/A | N/A | N/A | N/A | | |
RequestedByAssigneeID | Edm.Int32 | true | true |
false
| N/A | N/A | N/A | N/A | N/A | | |
RequestedByGroupsOfResourceID | Edm.Int32 | false | false |
true
| N/A | N/A | N/A | N/A | N/A | | |
RequestedForAssigneeID | Edm.Int32 | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
RequestedForGroupsOfResourceID | Edm.Int32 | true | false |
true
| N/A | N/A | N/A | N/A | N/A | | |
RequestReason | Edm.String | true | false |
false
| 1000 | N/A | N/A | N/A | N/A | | |
ServiceRequestStatusID | Nlyte.Model.ServiceRequestStatus | false | false |
true
| N/A | N/A | N/A | N/A | N/A | | |
SLAExpired | Edm.Boolean | false | false |
true
| N/A | N/A | N/A | N/A | N/A | | |
TechnicalLiaisonAssigneeID | Edm.Int32 | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
TechnicalLiaisonGroupsOfResourceID | Edm.Int32 | true | false |
true
| N/A | N/A | N/A | N/A | N/A | | |
UntrustedLocationGroupId | Edm.Int32 | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
Version | Edm.Int32 | false | false |
true
| N/A | N/A | N/A | N/A | N/A | | |
Viewed | Edm.Boolean | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
WorkflowID | Edm.Guid | true | false |
true
| N/A | N/A | N/A | N/A | N/A | | |
ServiceRequest Navigational Properties
Verb(s) | Required Permission(s) | Link | Description |
---|
Get | WS-ReadFile | | |
Delete | WS-ModifyFile | | |
ServiceRequestFile Structural Properties
No structural properties
ServiceRequestFile Navigational Properties
No navigational properties
Verb(s) | Required Permission(s) | Link | Description |
---|
Post | WS-AddNote | | |
Patch | WS-ModifyNote | | |
Delete | WS-ModifyNote | | |
Get | WS-ReadNote | | |
ServiceRequestNote Structural Properties
No structural properties
ServiceRequestNote Navigational Properties
No navigational properties
Verb(s) | Required Permission(s) | Link | Description |
---|
Get | WS-ReadShelf | integration/api/odata/Shelfs, integration/api/odata/Shelfs({key}) | |
Post | WS-AddShelf | integration/api/odata/Shelfs | |
Patch | WS-ModifyShelf | integration/api/odata/Shelfs({key}) | |
PostWithKey | WS-ModifyShelf | | |
Shelf Structural Properties
Property | Type | Nullable | Mandatory | Read-Only | String length | Min Value | Max Value | Precision | Max Dec Places | Is Only Date | Description |
---|
CabinetAssetID | Edm.Int32 | false | true |
false
| N/A | N/A | N/A | N/A | N/A | | |
CabinetUNumber | Edm.Int32 | true | false |
true
| N/A | N/A | N/A | N/A | N/A | | The U on which the shelf is mounted |
Depth | Edm.Double | false | false |
true
| N/A | N/A | N/A | N/A | N/A | | |
Height | Edm.Double | false | false |
true
| N/A | N/A | N/A | N/A | N/A | | |
LowerCabinetU | Edm.Int32 | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | The bottom U position in which the asset is mounted. |
ShelfID | Edm.Int32 | false | false |
true
| N/A | N/A | N/A | N/A | N/A | | |
ShelfName | Edm.String | true | false |
false
| 100 | N/A | N/A | N/A | N/A | | |
UDisplayLabel | Edm.Int32 | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | The U label to be displayed, representing the top or the bottom U position, depending on the admin parameter |
UMountingID | Edm.Int32 | true | false |
true
| N/A | N/A | N/A | N/A | N/A | | The foreign key identifying the entity providing details about the Cabinet U in which an asset is mounted. |
WeightLimit | Edm.Double | false | true |
false
| N/A | N/A | N/A | N/A | N/A | | |
Width | Edm.Double | false | false |
true
| N/A | N/A | N/A | N/A | N/A | | |
Xcoord | Edm.Double | false | false |
true
| N/A | N/A | N/A | N/A | N/A | | |
Ycoord | Edm.Double | false | false |
true
| N/A | N/A | N/A | N/A | N/A | | |
YOffset | Edm.Double | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
Zcoord | Edm.Double | false | false |
true
| N/A | N/A | N/A | N/A | N/A | | |
Shelf Navigational Properties
Verb(s) | Required Permission(s) | Link | Description |
---|
Get | WS-ReadSoftware | integration/api/odata/Softwares, integration/api/odata/Softwares({key}) | |
Post | WS-AddSoftware | integration/api/odata/Softwares | |
PostWithKey | WS-ModifySoftware | | |
Patch | WS-ModifySoftware | integration/api/odata/Softwares({key}) | |
Delete | WS-ModifySoftware | integration/api/odata/Softwares({key}) | |
Software Structural Properties
Property | Type | Nullable | Mandatory | Read-Only | String length | Min Value | Max Value | Precision | Max Dec Places | Is Only Date | Description |
---|
IsManagementSoftware | Edm.Boolean | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
IsOperatingSystem | Edm.Boolean | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
IsWebApplication | Edm.Boolean | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
RecordStatus | Nlyte.Model.SoftwareRecordStatus | false | true |
false
| N/A | N/A | N/A | N/A | N/A | | |
SoftwareID | Edm.Int32 | false | false |
true
| N/A | N/A | N/A | N/A | N/A | | |
SoftwareManufacturerID | Edm.Int32 | true | true |
false
| N/A | N/A | N/A | N/A | N/A | | The manufacturer ID, used from the predefined list of manufacturers. |
SoftwareName | Edm.String | false | true |
false
| 100 | N/A | N/A | N/A | N/A | | Software Name. This needs to be Unique in the system. |
SoftwareNumber | Edm.Int32 | false | false |
true
| N/A | N/A | N/A | N/A | N/A | | |
SoftwareTypeID | Edm.Int32 | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
Version | Edm.String | true | false |
false
| 30 | N/A | N/A | N/A | N/A | | |
Software Navigational Properties
Verb(s) | Required Permission(s) | Link | Description |
---|
Get | WS-ReadFile | | |
Delete | WS-ModifyFile | | |
SoftwareFile Structural Properties
No structural properties
SoftwareFile Navigational Properties
No navigational properties
Verb(s) | Required Permission(s) | Link | Description |
---|
Key(s) |
---|
SoftwareManufacturerID |
SoftwareManufacturer Structural Properties
Property | Type | Nullable | Mandatory | Read-Only | String length | Min Value | Max Value | Precision | Max Dec Places | Is Only Date | Description |
---|
Detail | Edm.String | false | true |
false
| 30 | N/A | N/A | N/A | N/A | | |
SoftwareManufacturerID | Edm.Int32 | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
SoftwareManufacturer Navigational Properties
No navigational properties
Verb(s) | Required Permission(s) | Link | Description |
---|
SoftwareType Structural Properties
Property | Type | Nullable | Mandatory | Read-Only | String length | Min Value | Max Value | Precision | Max Dec Places | Is Only Date | Description |
---|
Detail | Edm.String | false | true |
false
| 30 | N/A | N/A | N/A | N/A | | Software type |
SoftwareTypeID | Edm.Int32 | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
SoftwareType Navigational Properties
No navigational properties
Verb(s) | Required Permission(s) | Link | Description |
---|
SqlView Structural Properties
Property | Type | Nullable | Mandatory | Read-Only | String length | Min Value | Max Value | Precision | Max Dec Places | Is Only Date | Description |
---|
Name | Edm.String | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
SqlView Navigational Properties
No navigational properties
Verb(s) | Required Permission(s) | Link | Description |
---|
SqlViewValue Structural Properties
Property | Type | Nullable | Mandatory | Read-Only | String length | Min Value | Max Value | Precision | Max Dec Places | Is Only Date | Description |
---|
ID | Edm.Int32 | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
Name | Edm.String | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
SqlViewValue Navigational Properties
No navigational properties
Verb(s) | Required Permission(s) | Link | Description |
---|
Get | WS-ReadAuxiliaryMaterial | integration/api/odata/StandardGeneratorAuxiliaryMaterials, integration/api/odata/StandardGeneratorAuxiliaryMaterials({key}) | |
Post | WS-AddAuxiliaryMaterial | integration/api/odata/StandardGeneratorAuxiliaryMaterials | |
PostWithKey | WS-ModifyAuxiliaryMaterial | | |
Patch | WS-ModifyAuxiliaryMaterial | integration/api/odata/StandardGeneratorAuxiliaryMaterials({key}) | |
Delete | WS-ModifyAuxiliaryMaterial | integration/api/odata/StandardGeneratorAuxiliaryMaterials({key}) | |
StandardGeneratorAuxiliaryMaterial Structural Properties
No structural properties
StandardGeneratorAuxiliaryMaterial Navigational Properties
No navigational properties
Verb(s) | Required Permission(s) | Link | Description |
---|
Get | WS-ReadNetworkMaterial | integration/api/odata/StandardNetworkMaterials, integration/api/odata/StandardNetworkMaterials({key}) | |
Post | WS-AddNetworkMaterial | integration/api/odata/StandardNetworkMaterials | |
PostWithKey | WS-ModifyNetworkMaterial | integration/api/odata/StandardNetworkMaterials({key}) | |
Patch | WS-ModifyNetworkMaterial | integration/api/odata/StandardNetworkMaterials({key}) | |
Delete | WS-ModifyNetworkMaterial | integration/api/odata/StandardNetworkMaterials({key}) | |
StandardNetworkMaterial Structural Properties
Property | Type | Nullable | Mandatory | Read-Only | String length | Min Value | Max Value | Precision | Max Dec Places | Is Only Date | Description |
---|
AirflowTypeID | Nlyte.Model.AirflowTypeEnum | false | true |
false
| N/A | N/A | N/A | N/A | N/A | | Selected air flow, from the available values defined in the administration area |
CalculatedMpafPowerConsumption | Edm.Decimal | true | false |
true
| N/A | N/A | N/A | N/A | N/A | | Read-only property, value provided by the service based on the PublishedPowerConsumption and the MpafOverride |
ConsumerPowerFactor | Edm.Decimal | false | false |
true
| N/A | N/A | N/A | N/A | N/A | | |
MaterialCategoryID | Edm.Int32 | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
MpafOverride | Edm.Decimal | true | false |
false
| N/A | 0.001 | 999 | 6 | 3 | | Value inserted by the user, while the material is in Planned status |
PowerTypeID | Nlyte.Model.PowerTypeEnum | false | true |
false
| N/A | N/A | N/A | N/A | N/A | | Power type: phased or direct current |
PublishedPowerConsumption | Edm.Decimal | true | true |
false
| N/A | 0.001 | 999 | 6 | 3 | | Value inserted by the user, while the material is in Planned status |
RequiredPlugs | Edm.Int32 | false | true |
false
| N/A | N/A | N/A | N/A | N/A | | Value inserted by the user, while the material is in Planned status |
RequiresDiversePower | Edm.Boolean | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | Value available to be updated by the user only if RequiredPlugs TotalPlugs |
WorkableFootPrintFront | Edm.Double | false | false |
false
| N/A | 0 | 999999999999.9999 | 16 | 4 | | |
WorkableFootPrintHeight | Edm.Double | false | false |
false
| N/A | 0 | 999999999999.9999 | 16 | 4 | | |
WorkableFootPrintRear | Edm.Double | false | false |
false
| N/A | 0 | 999999999999.9999 | 16 | 4 | | |
StandardNetworkMaterial Navigational Properties
Verb(s) | Required Permission(s) | Link | Description |
---|
Get | WS-ReadPDUMaterial | integration/api/odata/StandardPDUMaterials, integration/api/odata/StandardPDUMaterials({key}) | |
Post | WS-AddPDUMaterial | integration/api/odata/StandardPDUMaterials | |
PostWithKey | WS-ModifyPDUMaterial | | |
Patch | WS-ModifyPDUMaterial | integration/api/odata/StandardPDUMaterials({key}) | |
Delete | WS-ModifyPDUMaterial | integration/api/odata/StandardPDUMaterials({key}) | |
StandardPDUMaterial Structural Properties
No structural properties
StandardPDUMaterial Navigational Properties
No navigational properties
Verb(s) | Required Permission(s) | Link | Description |
---|
Get | WS-ReadServerMaterial | integration/api/odata/StandardServerMaterials, integration/api/odata/StandardServerMaterials({key}) | |
Post | WS-AddServerMaterial | integration/api/odata/StandardServerMaterials | |
PostWithKey | WS-ModifyServerMaterial | integration/api/odata/StandardServerMaterials({key}) | |
Patch | WS-ModifyServerMaterial | integration/api/odata/StandardServerMaterials({key}) | |
Delete | WS-ModifyServerMaterial | integration/api/odata/StandardServerMaterials({key}) | |
StandardServerMaterial Structural Properties
Property | Type | Nullable | Mandatory | Read-Only | String length | Min Value | Max Value | Precision | Max Dec Places | Is Only Date | Description |
---|
AirflowTypeID | Nlyte.Model.AirflowTypeEnum | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | Selected air flow, from the available values defined in the administration area |
MaterialCategoryID | Edm.Int32 | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
PlugType | Edm.String | true | false |
false
| 50 | N/A | N/A | N/A | N/A | | Property selected from the available types, available as lookups InputConnectorTypes |
PowerTypeID | Nlyte.Model.PowerTypeEnum | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | Power type: phased or direct current |
PublishedPowerConsumption | Edm.Decimal | false | false |
false
| N/A | 0.001 | 999 | 6 | 3 | | |
RequiredPlugs | Edm.Int32 | false | true |
false
| N/A | N/A | N/A | N/A | N/A | | Value inserted by the user, while the material is in Planned status |
RequiresDiversePower | Edm.Boolean | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | Value available to be updated by the user only if RequiredPlugs TotalPlugs |
RequiresKVMSwitch | Edm.Boolean | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
TotalPlugs | Edm.Int32 | false | true |
false
| N/A | N/A | N/A | N/A | N/A | | Value inserted by the user, while the material is in Planned status |
WorkableFootPrintFront | Edm.Double | false | false |
false
| N/A | 0 | 999999999999.9999 | 16 | 4 | | |
WorkableFootPrintHeight | Edm.Double | false | false |
false
| N/A | 0 | 999999999999.9999 | 16 | 4 | | |
WorkableFootPrintRear | Edm.Double | false | false |
false
| N/A | 0 | 999999999999.9999 | 16 | 4 | | |
StandardServerMaterial Navigational Properties
No navigational properties
StaticSwitch Entity
: Asset
- Asset created from a material of type static switch, entity inheriting the Nlyte.Model.Asset entity
Verb(s) | Required Permission(s) | Link | Description |
---|
Get | WS-ReadStaticSwitch | integration/api/odata/StaticSwitches, integration/api/odata/StaticSwitches({key}) | |
Patch | WS-ModifyStaticSwitch | integration/api/odata/StaticSwitches({key}) | |
PostWithKey | WS-ModifyStaticSwitch | integration/api/odata/StaticSwitches({key}) | |
Delete | WS-ModifyStaticSwitch | integration/api/odata/StaticSwitches({key}) | |
Post | WS-AddStaticSwitch | integration/api/odata/StaticSwitches | |
StaticSwitch Structural Properties
Property | Type | Nullable | Mandatory | Read-Only | String length | Min Value | Max Value | Precision | Max Dec Places | Is Only Date | Description |
---|
AuditDate | Edm.DateTimeOffset | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
AuditStatusCorrect | Edm.Boolean | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
CurrentPowerFactor | Edm.Decimal | true | false |
true
| N/A | N/A | N/A | N/A | N/A | | Read-only property representing the percentage of power drawn by a PDD asset that is available to its consumers |
IsMasterRedundancyDevice | Edm.Boolean | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | Value inserted by the user |
LastAuditorAccountID | Edm.Int32 | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
OutputCount | Edm.Int32 | false | false |
true
| N/A | N/A | N/A | N/A | N/A | | |
PowerFactorOverride | Edm.Decimal | true | false |
false
| N/A | 0 | 1 | 3 | 2 | | Value provided by the user, overriding the CurrentPowerFactor value |
RealtimePowerFactor | Edm.Decimal | true | false |
true
| N/A | N/A | N/A | N/A | N/A | | Read-only value. |
TotalPlugs | Edm.Int32 | false | false |
true
| N/A | N/A | N/A | N/A | N/A | | |
StaticSwitch Navigational Properties
Verb(s) | Required Permission(s) | Link | Description |
---|
Get | WS-ReadStaticSwitchMaterial | integration/api/odata/StaticSwitchMaterials, integration/api/odata/StaticSwitchMaterials({key}) | |
Post | WS-AddStaticSwitchMaterial | integration/api/odata/StaticSwitchMaterials | |
PostWithKey | WS-ModifyStaticSwitchMaterial | integration/api/odata/StaticSwitchMaterials({key}) | |
Patch | WS-ModifyStaticSwitchMaterial | integration/api/odata/StaticSwitchMaterials({key}) | |
Delete | WS-ModifyStaticSwitchMaterial | integration/api/odata/StaticSwitchMaterials({key}) | |
StaticSwitchMaterial Structural Properties
Property | Type | Nullable | Mandatory | Read-Only | String length | Min Value | Max Value | Precision | Max Dec Places | Is Only Date | Description |
---|
CalculatedMaxKW | Edm.Decimal | true | false |
true
| N/A | N/A | N/A | N/A | N/A | | |
DistributorPowerFactor | Edm.Decimal | false | false |
true
| N/A | N/A | N/A | N/A | N/A | | |
InputPowerTypeID | Nlyte.Model.PowerTypeEnum | false | true |
false
| N/A | N/A | N/A | N/A | N/A | | Power type: phased or direct current |
MaterialCategoryID | Edm.Int32 | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
MaxAmperage | Edm.Decimal | true | false |
false
| N/A | 0 | 99999.999 | 8 | 3 | | |
MaxVoltage | Edm.Decimal | true | false |
false
| N/A | 0 | 99999.999 | 8 | 3 | | |
TotalOutlets | Edm.Int32 | false | true |
false
| N/A | N/A | N/A | N/A | N/A | | |
TotalPlugs | Edm.Int32 | false | false |
true
| N/A | N/A | N/A | N/A | N/A | | Value inserted by the user, while the material is in Planned status |
UHeight | Edm.Int64 | false | false |
true
| N/A | N/A | N/A | N/A | N/A | | |
WorkableFootPrintFront | Edm.Double | false | false |
false
| N/A | 0 | 999999999999.9999 | 16 | 4 | | |
WorkableFootPrintHeight | Edm.Double | false | false |
false
| N/A | 0 | 999999999999.9999 | 16 | 4 | | |
WorkableFootPrintRear | Edm.Double | false | false |
false
| N/A | 0 | 999999999999.9999 | 16 | 4 | | |
StaticSwitchMaterial Navigational Properties
Verb(s) | Required Permission(s) | Link | Description |
---|
Get | WS-ReadPeripheralMaterial | integration/api/odata/StoragePeripheralMaterials, integration/api/odata/StoragePeripheralMaterials({key}) | |
Post | WS-AddPeripheralMaterial | integration/api/odata/StoragePeripheralMaterials | |
PostWithKey | WS-ModifyPeripheralMaterial | integration/api/odata/StoragePeripheralMaterials({key}) | |
Patch | WS-ModifyPeripheralMaterial | integration/api/odata/StoragePeripheralMaterials({key}) | |
Delete | WS-ModifyPeripheralMaterial | integration/api/odata/StoragePeripheralMaterials({key}) | |
StoragePeripheralMaterial Structural Properties
Property | Type | Nullable | Mandatory | Read-Only | String length | Min Value | Max Value | Precision | Max Dec Places | Is Only Date | Description |
---|
AirflowTypeID | Nlyte.Model.AirflowTypeEnum | true | true |
false
| N/A | N/A | N/A | N/A | N/A | | Selected air flow, from the available values defined in the administration area |
CalculatedMpafPowerConsumption | Edm.Decimal | true | false |
true
| N/A | N/A | N/A | N/A | N/A | | |
ConsumerPowerFactor | Edm.Decimal | false | false |
true
| N/A | N/A | N/A | N/A | N/A | | |
MpafOverride | Edm.Decimal | true | false |
false
| N/A | 0.001 | 999 | 6 | 3 | | Value inserted by the user, while the material is in Planned status |
PowerTypeID | Nlyte.Model.PowerTypeEnum | true | true |
false
| N/A | N/A | N/A | N/A | N/A | | Power type: phased or direct current |
PublishedPowerConsumption | Edm.Decimal | true | false |
false
| N/A | 0.001 | 999 | 6 | 3 | | Value inserted by the user, while the material is in Planned status |
RequiredPlugs | Edm.Int32 | true | true |
false
| N/A | N/A | N/A | N/A | N/A | | Value inserted by the user, while the material is in Planned status |
RequiresDiversePower | Edm.Boolean | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
TotalPlugs | Edm.Int32 | true | true |
false
| N/A | N/A | N/A | N/A | N/A | | Value inserted by the user, while the material is in Planned status |
WorkableFootPrintFront | Edm.Double | false | false |
false
| N/A | 0 | 999999999999.9999 | 16 | 4 | | |
WorkableFootPrintHeight | Edm.Double | false | false |
false
| N/A | 0 | 999999999999.9999 | 16 | 4 | | |
WorkableFootPrintRear | Edm.Double | false | false |
false
| N/A | 0 | 999999999999.9999 | 16 | 4 | | |
StoragePeripheralMaterial Navigational Properties
Verb(s) | Required Permission(s) | Link | Description |
---|
StorageUsage Structural Properties
Property | Type | Nullable | Mandatory | Read-Only | String length | Min Value | Max Value | Precision | Max Dec Places | Is Only Date | Description |
---|
Detail | Edm.String | false | true |
false
| 30 | N/A | N/A | N/A | N/A | | Storage Usage |
StorageUsageID | Edm.Int32 | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
StorageUsage Navigational Properties
No navigational properties
Verb(s) | Required Permission(s) | Link | Description |
---|
Get | WS-ReadCabinetSubnetMap | integration/api/odata/Subnets, integration/api/odata/Subnets({key}) | |
Post | WS-AddCabinetSubnetMap | integration/api/odata/Subnets | |
Patch | WS-ModifyCabinetSubnetMap | integration/api/odata/Subnets({key}) | |
PostWithKey | WS-ModifyCabinetSubnetMap | | |
Delete | WS-ModifyCabinetSubnetMap | integration/api/odata/Subnets({key}) | |
Subnet Structural Properties
Property | Type | Nullable | Mandatory | Read-Only | String length | Min Value | Max Value | Precision | Max Dec Places | Is Only Date | Description |
---|
CIDR | Edm.Byte | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
FirstOctetA | Edm.Byte | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
FirstOctetB | Edm.Byte | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
FirstOctetC | Edm.Byte | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
FirstOctetD | Edm.Byte | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
LastOctetA | Edm.Byte | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
LastOctetB | Edm.Byte | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
LastOctetC | Edm.Byte | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
LastOctetD | Edm.Byte | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
OctetA | Edm.Byte | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
OctetB | Edm.Byte | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
OctetC | Edm.Byte | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
OctetD | Edm.Byte | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
SubnetID | Edm.Int32 | false | false |
true
| N/A | N/A | N/A | N/A | N/A | | |
Subnet Navigational Properties
Verb(s) | Required Permission(s) | Link | Description |
---|
Get | WS-ReadSubnetLocationGroupMap | integration/api/odata/SubnetLocationGroupMaps, integration/api/odata/SubnetLocationGroupMaps({key}) | |
Post | WS-AddSubnetLocationGroupMap | integration/api/odata/SubnetLocationGroupMaps | |
PostWithKey | WS-ModifySubnetLocationGroupMap | | |
Patch | WS-ModifySubnetLocationGroupMap | integration/api/odata/SubnetLocationGroupMaps({key}) | |
Delete | WS-ModifySubnetLocationGroupMap | integration/api/odata/SubnetLocationGroupMaps({key}) | |
Key(s) |
---|
LocationGroupSubnetMapID |
SubnetLocationGroupMap Structural Properties
Property | Type | Nullable | Mandatory | Read-Only | String length | Min Value | Max Value | Precision | Max Dec Places | Is Only Date | Description |
---|
LocationGroupID | Edm.Int32 | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | Foreign key identifying the location |
LocationGroupSubnetMapID | Edm.Int32 | false | false |
true
| N/A | N/A | N/A | N/A | N/A | | |
SubnetID | Edm.Int32 | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
SubnetLocationGroupMap Navigational Properties
Verb(s) | Required Permission(s) | Link | Description |
---|
SubStatus Structural Properties
Property | Type | Nullable | Mandatory | Read-Only | String length | Min Value | Max Value | Precision | Max Dec Places | Is Only Date | Description |
---|
Active | Edm.Boolean | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
Name | Edm.String | false | true |
false
| 25 | N/A | N/A | N/A | N/A | | |
SubStatusID | Edm.Int32 | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
SubStatus Navigational Properties
No navigational properties
Verb(s) | Required Permission(s) | Link | Description |
---|
Get | WS-ReadUtility | integration/api/odata/Utilities, integration/api/odata/Utilities({key}) | |
Patch | WS-ModifyUtility | | |
Delete | WS-ModifyUtility | | |
PostWithKey | WS-ModifyUtility | | |
Post | WS-AddUtility | | |
Supplier Structural Properties
Property | Type | Nullable | Mandatory | Read-Only | String length | Min Value | Max Value | Precision | Max Dec Places | Is Only Date | Description |
---|
AssetID | Edm.Int32 | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | Id of the asset acting as power distributor |
CommercialSupplyVoltage | Edm.Int32 | true | |
false
| | | | | | | |
CostPerUnitDay | Edm.Decimal | true | false |
false
| N/A | 0 | 999999.99 | 8 | 2 | | |
CostPerUnitNight | Edm.Decimal | true | false |
false
| N/A | 0 | 999999.99 | 8 | 2 | | |
FixedCost | Edm.Decimal | true | false |
false
| N/A | 0 | 999999.99 | 8 | 2 | | |
LocationGroupID | Edm.Int32 | false | false |
true
| N/A | N/A | N/A | N/A | N/A | | |
MaxKVA | Edm.Decimal | true | false |
false
| N/A | 0 | 99999999.9999 | 12 | 4 | | |
MPAN | Edm.String | true | false |
false
| 50 | N/A | N/A | N/A | N/A | | |
Name | Edm.String | true | false |
false
| 50 | N/A | N/A | N/A | N/A | | |
PowerTypeID | Nlyte.Model.PowerTypeEnum | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | Power type: phased or direct current |
SupplierID | Edm.Int32 | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
SupplierTypeID | Nlyte.Model.SupplierTypeEnum | false | false |
true
| N/A | N/A | N/A | N/A | N/A | | |
Supplier Navigational Properties
Verb(s) | Required Permission(s) | Link | Description |
---|
SupplierMaterial Structural Properties
Property | Type | Nullable | Mandatory | Read-Only | String length | Min Value | Max Value | Precision | Max Dec Places | Is Only Date | Description |
---|
AvailableKVAh | Edm.Decimal | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
CostPerUnit | Edm.Decimal | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
FixedCost | Edm.Decimal | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
MaterialID | Edm.Int32 | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
MaxKVA | Edm.Decimal | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
Name | Edm.String | false | true |
false
| 50 | N/A | N/A | N/A | N/A | | |
PowerTypeID | Nlyte.Model.PowerTypeEnum | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | Power type: phased or direct current |
SupplierMaterialID | Edm.Int32 | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
SupplierTypeID | Nlyte.Model.SupplierTypeEnum | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
SupplierMaterial Navigational Properties
Verb(s) | Required Permission(s) | Link | Description |
---|
Key(s) |
---|
SupplierMaterialWireID |
SupplierMaterialWire Structural Properties
Property | Type | Nullable | Mandatory | Read-Only | String length | Min Value | Max Value | Precision | Max Dec Places | Is Only Date | Description |
---|
Phase | Edm.Int32 | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
Position | Edm.Int32 | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
SupplierMaterialID | Edm.Int32 | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
SupplierMaterialWireID | Edm.Int32 | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
SupplierMaterialWire Navigational Properties
Verb(s) | Required Permission(s) | Link | Description |
---|
Get | WS-ReadUtility | | |
Patch | WS-ModifyUtility | | |
Delete | WS-ModifyUtility | | |
PostWithKey | WS-ModifyUtility | | |
Post | WS-ModifyUtility | | |
SupplierWire Structural Properties
Property | Type | Nullable | Mandatory | Read-Only | String length | Min Value | Max Value | Precision | Max Dec Places | Is Only Date | Description |
---|
Phase | Edm.Int32 | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
Position | Edm.Int32 | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
SupplierID | Edm.Int32 | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
SupplierWireID | Edm.Int32 | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
SupplierWire Navigational Properties
Verb(s) | Required Permission(s) | Link | Description |
---|
Get | WS-ReadSupportGroup | integration/api/odata/SupportGroups, integration/api/odata/SupportGroups({key}) | |
Patch | WS-ModifySupportGroup | integration/api/odata/SupportGroups({key}) | |
Delete | WS-ModifySupportGroup | integration/api/odata/SupportGroups({key}) | |
Post | WS-AddSupportGroup | integration/api/odata/SupportGroups | |
PostWithKey | WS-ModifySupportGroup | integration/api/odata/SupportGroups({key}) | |
SupportGroup Structural Properties
Property | Type | Nullable | Mandatory | Read-Only | String length | Min Value | Max Value | Precision | Max Dec Places | Is Only Date | Description |
---|
AssigneeID | Edm.Int32 | false | false |
true
| N/A | N/A | N/A | N/A | N/A | | |
Description | Edm.String | true | false |
false
| 255 | N/A | N/A | N/A | N/A | | |
EmailAddress | Edm.String | true | false |
false
| 254 | N/A | N/A | N/A | N/A | | |
HasChildren | Edm.Boolean | false | false |
true
| N/A | N/A | N/A | N/A | N/A | | Group was used as a parent group |
ParentSupportGroupID | Edm.Int32 | false | true |
true
| N/A | N/A | N/A | N/A | N/A | | |
RecordStatus | Nlyte.Model.OrganisationGroupRecordStatus | false | false |
true
| N/A | N/A | N/A | N/A | N/A | | Reflects the real status of the group as is in the data-center Canceled or Active. |
SupportGroupID | Edm.Int32 | true | false |
true
| N/A | N/A | N/A | N/A | N/A | | |
SupportGroupName | Edm.String | false | true |
false
| 255 | N/A | N/A | N/A | N/A | | |
SupportGroupNumber | Edm.Int32 | true | false |
true
| N/A | N/A | N/A | N/A | N/A | | |
TelephoneNumber | Edm.String | true | false |
false
| 30 | N/A | N/A | N/A | N/A | | |
SupportGroup Navigational Properties
Verb(s) | Required Permission(s) | Link | Description |
---|
Get | WS-ReadSupportGroupAssetMap | | |
Patch | WS-ModifySupportGroupAssetMap | | |
Delete | WS-ModifySupportGroupAssetMap | | |
Post | WS-AddSupportGroupAssetMap | | |
PostWithKey | WS-ModifySupportGroupAssetMap | | |
SupportGroupAssetMap Structural Properties
Property | Type | Nullable | Mandatory | Read-Only | String length | Min Value | Max Value | Precision | Max Dec Places | Is Only Date | Description |
---|
ColourIndex | Edm.Int32 | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
CultureID | Edm.Int32 | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
Description | Edm.String | true | false |
false
| 255 | N/A | N/A | N/A | N/A | | |
EmailAddress | Edm.String | true | false |
false
| 254 | N/A | N/A | N/A | N/A | | |
ID | Edm.Int32 | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
ParentSupportGroupID | Edm.Int32 | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
RecordStatus | Edm.Int32 | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
SupportGroupID | Edm.Int32 | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
SupportGroupName | Edm.String | true | false |
false
| 255 | N/A | N/A | N/A | N/A | | |
SupportGroupNumber | Edm.Int32 | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
SupportPercentage | Edm.Byte | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
TelephoneNumber | Edm.String | true | false |
false
| 30 | N/A | N/A | N/A | N/A | | |
SupportGroupAssetMap Navigational Properties
Verb(s) | Required Permission(s) | Link | Description |
---|
Post | WS-AddNote | | |
Patch | WS-ModifyNote | | |
Delete | WS-ModifyNote | | |
Get | WS-ReadNote | | |
SupportGroupNote Structural Properties
No structural properties
SupportGroupNote Navigational Properties
No navigational properties
Verb(s) | Required Permission(s) | Link | Description |
---|
Get | WS-ReadSupportGroupResourceMap | | |
Patch | WS-ModifySupportGroupResourceMap | | |
Delete | WS-ModifySupportGroupResourceMap | | |
Post | WS-AddSupportGroupResourceMap | | |
PostWithKey | WS-ModifySupportGroupResourceMap | | |
Key(s) |
---|
SupportGroupResourceMapID |
SupportGroupResourceMap Structural Properties
Property | Type | Nullable | Mandatory | Read-Only | String length | Min Value | Max Value | Precision | Max Dec Places | Is Only Date | Description |
---|
ClientUserGUID | Edm.String | true | false |
true
| 100 | N/A | N/A | N/A | N/A | | |
Company | Edm.String | true | false |
true
| 50 | N/A | N/A | N/A | N/A | | |
CompanyPhoneNumber | Edm.String | true | false |
true
| 50 | N/A | N/A | N/A | N/A | | |
CultureID | Edm.Int32 | true | false |
true
| N/A | N/A | N/A | N/A | N/A | | |
Department | Edm.String | true | false |
true
| 50 | N/A | N/A | N/A | N/A | | |
DepartmentPhoneNumber | Edm.String | true | false |
true
| 50 | N/A | N/A | N/A | N/A | | |
Email | Edm.String | true | false |
true
| 254 | N/A | N/A | N/A | N/A | | |
Forename | Edm.String | true | false |
true
| 50 | N/A | N/A | N/A | N/A | | |
ManagerResourceID | Edm.Int32 | true | false |
true
| N/A | N/A | N/A | N/A | N/A | | |
MeasurementSystemID | Edm.Int32 | true | false |
true
| N/A | N/A | N/A | N/A | N/A | | |
Middlename | Edm.String | true | false |
true
| 50 | N/A | N/A | N/A | N/A | | |
MobileNumber | Edm.String | true | false |
true
| 50 | N/A | N/A | N/A | N/A | | |
PhoneNumber | Edm.String | true | false |
true
| 50 | N/A | N/A | N/A | N/A | | |
Priority | Edm.Int32 | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
ResourceID | Edm.Int32 | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
RFIDCardID | Edm.String | true | false |
true
| 50 | N/A | N/A | N/A | N/A | | |
SupportGroupID | Edm.Int32 | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
SupportGroupResourceMapID | Edm.Int32 | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
Surname | Edm.String | true | false |
true
| 50 | N/A | N/A | N/A | N/A | | |
TimeZone | Edm.Double | true | false |
true
| N/A | N/A | N/A | N/A | N/A | | |
Title | Edm.String | true | false |
true
| 10 | N/A | N/A | N/A | N/A | | |
SupportGroupResourceMap Navigational Properties
Verb(s) | Required Permission(s) | Link | Description |
---|
Task Structural Properties
Property | Type | Nullable | Mandatory | Read-Only | String length | Min Value | Max Value | Precision | Max Dec Places | Is Only Date | Description |
---|
Configuration | Edm.String | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
DisplayOrder | Edm.Int32 | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
DurationInMins | Edm.Int64 | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
ID | Edm.Int32 | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
Instructions | Edm.String | true | false |
false
| 1000 | N/A | N/A | N/A | N/A | | |
ItemProcessDescription | Edm.String | true | false |
false
| 100 | N/A | N/A | N/A | N/A | | |
Name | Edm.String | false | true |
false
| 250 | N/A | N/A | N/A | N/A | | |
OnErrorAction | Edm.Int32 | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
ParentTaskContainerID | Edm.Int32 | true | true |
false
| N/A | N/A | N/A | N/A | N/A | | |
PerformerAssigneeID | Edm.Int32 | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
ProcessID | Edm.Int32 | true | false |
true
| N/A | N/A | N/A | N/A | N/A | | |
SequenceNumber | Edm.Int32 | false | true |
false
| N/A | N/A | N/A | N/A | N/A | | |
SLANotificationExpiryTimespan | Edm.Int64 | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
SLATimespan | Edm.Int64 | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
Type | Nlyte.Model.TaskType | false | |
false
| | | | | | | |
Task Navigational Properties
Verb(s) | Required Permission(s) | Link | Description |
---|
TaskContainer Structural Properties
Property | Type | Nullable | Mandatory | Read-Only | String length | Min Value | Max Value | Precision | Max Dec Places | Is Only Date | Description |
---|
DisplayOrder | Edm.Int32 | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
ID | Edm.Int32 | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
IsDefault | Edm.Boolean | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
MaximumLoops | Edm.Int32 | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
Name | Edm.String | true | |
false
| | | | | | | |
ParentTaskContainerID | Edm.Int32 | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
ProcessID | Edm.Int32 | true | false |
true
| N/A | N/A | N/A | N/A | N/A | | |
Rule | Edm.String | true | false |
false
| 2147483647 | N/A | N/A | N/A | N/A | | |
Type | Nlyte.Model.TaskContainerType | false | |
false
| | | | | | | |
TaskContainer Navigational Properties
Verb(s) | Required Permission(s) | Link | Description |
---|
TaskForm Structural Properties
Property | Type | Nullable | Mandatory | Read-Only | String length | Min Value | Max Value | Precision | Max Dec Places | Is Only Date | Description |
---|
FormID | Edm.Int32 | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
FormOrder | Edm.Int32 | false | false |
true
| N/A | N/A | N/A | N/A | N/A | | |
ID | Edm.Int32 | false | false |
true
| N/A | N/A | N/A | N/A | N/A | | |
TaskID | Edm.Int32 | true | false |
true
| N/A | N/A | N/A | N/A | N/A | | |
TaskForm Navigational Properties
Verb(s) | Required Permission(s) | Link | Description |
---|
TaskFormControl Structural Properties
Property | Type | Nullable | Mandatory | Read-Only | String length | Min Value | Max Value | Precision | Max Dec Places | Is Only Date | Description |
---|
FormControlID | Edm.Int32 | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
ID | Edm.Int32 | false | false |
true
| N/A | N/A | N/A | N/A | N/A | | |
IsEditable | Edm.Boolean | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
IsVisible | Edm.Boolean | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
TaskID | Edm.Int32 | true | false |
true
| N/A | N/A | N/A | N/A | N/A | | |
TaskFormControl Navigational Properties
Verb(s) | Required Permission(s) | Link | Description |
---|
Get | WS-ReadTask | integration/api/odata/TaskInstances, integration/api/odata/TaskInstances({key}) | |
Patch | WS-ModifyTask | integration/api/odata/TaskInstances({key}) | |
Put | WS-ModifyTask | integration/api/odata/TaskInstances({key}) | |
TaskInstance Structural Properties
Property | Type | Nullable | Mandatory | Read-Only | String length | Min Value | Max Value | Precision | Max Dec Places | Is Only Date | Description |
---|
AgingInMins | Edm.Int64 | false | false |
true
| N/A | N/A | N/A | N/A | N/A | | |
DateAgingLastUpdated | Edm.DateTimeOffset | true | false |
true
| N/A | N/A | N/A | N/A | N/A | | |
DateCreated | Edm.DateTimeOffset | false | false |
true
| N/A | N/A | N/A | N/A | N/A | | |
DateExpectedClosing | Edm.DateTimeOffset | true | false |
true
| N/A | N/A | N/A | N/A | N/A | | |
DateLastClosed | Edm.DateTimeOffset | true | false |
true
| N/A | N/A | N/A | N/A | N/A | | |
DateLastStatusChanged | Edm.DateTimeOffset | false | false |
true
| N/A | N/A | N/A | N/A | N/A | | |
DateStarted | Edm.DateTimeOffset | true | false |
true
| N/A | N/A | N/A | N/A | N/A | | |
FileCount | Edm.Int32 | false | false |
true
| N/A | N/A | N/A | N/A | N/A | | |
HasIntegrationActivity | Edm.Boolean | false | false |
true
| N/A | N/A | N/A | N/A | N/A | | |
ID | Edm.Int32 | false | false |
true
| N/A | N/A | N/A | N/A | N/A | | |
IsNew | Edm.Boolean | false | false |
true
| N/A | N/A | N/A | N/A | N/A | | |
IsOverdue | Edm.Boolean | false | false |
true
| N/A | N/A | N/A | N/A | N/A | | |
IssueCount | Edm.Int32 | false | false |
true
| N/A | N/A | N/A | N/A | N/A | | |
LastDateUpdated | Edm.DateTimeOffset | false | false |
true
| N/A | N/A | N/A | N/A | N/A | | |
NoteCount | Edm.Int32 | false | false |
true
| N/A | N/A | N/A | N/A | N/A | | |
OpenedCount | Edm.Int32 | true | false |
true
| N/A | N/A | N/A | N/A | N/A | | |
OwnerAssigneeID | Edm.Int32 | true | true |
false
| N/A | N/A | N/A | N/A | N/A | | |
OwnerGroupsOfResourceID | Edm.Int32 | false | false |
true
| N/A | N/A | N/A | N/A | N/A | | |
Priority | Nlyte.Model.Priority | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
PriorityFocusID | Nlyte.Model.PriorityFocus | false | false |
true
| N/A | N/A | N/A | N/A | N/A | | |
ServiceRequestID | Edm.Int32 | true | false |
true
| N/A | N/A | N/A | N/A | N/A | | |
SLANotified | Edm.Int32 | false | false |
true
| N/A | N/A | N/A | N/A | N/A | | |
SRViewerVisible | Edm.Boolean | true | false |
true
| N/A | N/A | N/A | N/A | N/A | | |
Status | Nlyte.Model.TaskInstanceStatus | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
TaskID | Edm.Int32 | true | false |
true
| N/A | N/A | N/A | N/A | N/A | | |
Version | Edm.Int32 | false | false |
true
| N/A | N/A | N/A | N/A | N/A | | |
Viewed | Edm.Boolean | false | false |
true
| N/A | N/A | N/A | N/A | N/A | | |
TaskInstance Navigational Properties
Verb(s) | Required Permission(s) | Link | Description |
---|
Get | WS-ReadFile | | |
Delete | WS-ModifyFile | | |
TaskInstanceFile Structural Properties
No structural properties
TaskInstanceFile Navigational Properties
No navigational properties
Verb(s) | Required Permission(s) | Link | Description |
---|
TaskInstanceIntegrationAttributes Structural Properties
Property | Type | Nullable | Mandatory | Read-Only | String length | Min Value | Max Value | Precision | Max Dec Places | Is Only Date | Description |
---|
ErrorDetails | Edm.String | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
NumberOfRetries | Edm.Int32 | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
OnErrorAction | Edm.Int32 | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
TaskInstanceId | Edm.Int32 | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
TaskInstanceIntegrationAttributes Navigational Properties
Verb(s) | Required Permission(s) | Link | Description |
---|
Post | WS-AddNote | | |
Patch | WS-ModifyNote | | |
Delete | WS-ModifyNote | | |
Get | WS-ReadNote | | |
TaskInstanceNote Structural Properties
No structural properties
TaskInstanceNote Navigational Properties
No navigational properties
Verb(s) | Required Permission(s) | Link | Description |
---|
TaskIntegrationAttributes Structural Properties
Property | Type | Nullable | Mandatory | Read-Only | String length | Min Value | Max Value | Precision | Max Dec Places | Is Only Date | Description |
---|
FormControlID | Edm.Int32 | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
ID | Edm.Int32 | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
IntegrationActivityParameterID | Edm.Int32 | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
TaskID | Edm.Int32 | true | false |
true
| N/A | N/A | N/A | N/A | N/A | | |
TaskIntegrationAttributes Navigational Properties
Verb(s) | Required Permission(s) | Link | Description |
---|
TextAreaControl Structural Properties
Property | Type | Nullable | Mandatory | Read-Only | String length | Min Value | Max Value | Precision | Max Dec Places | Is Only Date | Description |
---|
MaxLength | Edm.Int32 | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
RowSpan | Edm.Int32 | false | true |
false
| N/A | N/A | N/A | N/A | N/A | | |
TextAreaControl Navigational Properties
No navigational properties
Verb(s) | Required Permission(s) | Link | Description |
---|
TextAreaControlValue Structural Properties
No structural properties
TextAreaControlValue Navigational Properties
No navigational properties
Verb(s) | Required Permission(s) | Link | Description |
---|
TextInputControl Structural Properties
Property | Type | Nullable | Mandatory | Read-Only | String length | Min Value | Max Value | Precision | Max Dec Places | Is Only Date | Description |
---|
IsNumeric | Edm.Boolean | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
MaxLength | Edm.Int32 | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
TextInputControl Navigational Properties
No navigational properties
Verb(s) | Required Permission(s) | Link | Description |
---|
TextInputControlValue Structural Properties
No structural properties
TextInputControlValue Navigational Properties
No navigational properties
Verb(s) | Required Permission(s) | Link | Description |
---|
TraceAsset Structural Properties
Property | Type | Nullable | Mandatory | Read-Only | String length | Min Value | Max Value | Precision | Max Dec Places | Is Only Date | Description |
---|
AssetName | Edm.String | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
AssetNumber | Edm.Int32 | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
AvailableKW | Edm.Decimal | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
CabinetAssetID | Edm.Int32 | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
CabinetName | Edm.String | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
ChassisAssetID | Edm.Int32 | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
ConsumedKW1 | Edm.Decimal | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
ConsumedKW2 | Edm.Decimal | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
ConsumedKW3 | Edm.Decimal | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
ConsumedKWTotal | Edm.Decimal | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
FreeCopperPorts | Edm.Int32 | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
FreeFibrePorts | Edm.Int32 | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
HostingAssetID | Edm.Int32 | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
IsAccessible | Edm.Boolean | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
IsMasterRedundancyDevice | Edm.Boolean | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
MaterialID | Edm.Int32 | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
MaterialName | Edm.String | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
MaterialSubtypeID | Edm.Int32 | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
MaterialTypeID | Edm.Int32 | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
OperationalStatus | Nlyte.Model.OperationalStatusEnum | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
PowerState | Edm.Boolean | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
RecordStatus | Nlyte.Model.RecordStatusEnum | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
TotalCopperPorts | Edm.Int32 | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
TotalFibrePorts | Edm.Int32 | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
Wire1Phase | Edm.Int32 | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
Wire2Phase | Edm.Int32 | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
Wire3Phase | Edm.Int32 | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
TraceAsset Navigational Properties
Verb(s) | Required Permission(s) | Link | Description |
---|
Key(s) |
---|
StartPortKey |
EndPortKey |
TraceLink Structural Properties
Property | Type | Nullable | Mandatory | Read-Only | String length | Min Value | Max Value | Precision | Max Dec Places | Is Only Date | Description |
---|
Distance | Edm.Int32 | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | non-zero Integer value describing number of links away from the Port represented by the PortID parameter: Negative values represent an initial Cable Connection |
EndAssetID | Edm.Int32 | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
EndPortID | Edm.Int32 | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
EndPortKey | Edm.Int32 | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
EndPortLocation | Nlyte.Model.PortLocation | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
EndPortState | Nlyte.Model.PortState | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
GraphID | Edm.Int32 | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
HostingEndAssetID | Edm.Int32 | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
HostingStartAssetID | Edm.Int32 | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
StartAssetID | Edm.Int32 | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
StartPortID | Edm.Int32 | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
StartPortKey | Edm.Int32 | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
StartPortLocation | Nlyte.Model.PortLocation | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
StartPortState | Nlyte.Model.PortState | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
TraceLink Navigational Properties
Verb(s) | Required Permission(s) | Link | Description |
---|
TraceSummary Structural Properties
Property | Type | Nullable | Mandatory | Read-Only | String length | Min Value | Max Value | Precision | Max Dec Places | Is Only Date | Description |
---|
ID | Edm.Int32 | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
TraceSummary Navigational Properties
Verb(s) | Required Permission(s) | Link | Description |
---|
Get | WS-ReadAuxiliaryMaterial | integration/api/odata/TransformerAuxiliaryMaterials, integration/api/odata/TransformerAuxiliaryMaterials({key}) | |
Post | WS-AddAuxiliaryMaterial | integration/api/odata/TransformerAuxiliaryMaterials | |
PostWithKey | WS-ModifyAuxiliaryMaterial | | |
Patch | WS-ModifyAuxiliaryMaterial | integration/api/odata/TransformerAuxiliaryMaterials({key}) | |
Delete | WS-ModifyAuxiliaryMaterial | integration/api/odata/TransformerAuxiliaryMaterials({key}) | |
TransformerAuxiliaryMaterial Structural Properties
No structural properties
TransformerAuxiliaryMaterial Navigational Properties
No navigational properties
Verb(s) | Required Permission(s) | Link | Description |
---|
Get | WS-ReadCabinetMountedAssetMap | | |
Post | WS-AddCabinetMountedAssetMap | | |
PostWithKey | WS-ModifyCabinetMountedAssetMap | | |
Patch | WS-ModifyCabinetMountedAssetMap | | |
Delete | WS-ModifyCabinetMountedAssetMap | | |
UMounting Structural Properties
Property | Type | Nullable | Mandatory | Read-Only | String length | Min Value | Max Value | Precision | Max Dec Places | Is Only Date | Description |
---|
AutoConnectNetworkSubType | Nlyte.Model.NetworkSubTypeEnum | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
CabinetAssetID | Edm.Int32 | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | The cabinet asset ID in which the asset is mounted. |
CabinetUNumber | Edm.Int32 | true | false |
true
| N/A | N/A | N/A | N/A | N/A | | The U position in which the asset is mounted. |
LowerCabinetU | Edm.Int32 | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | The bottom U position in which the asset is mounted. |
MountingPlacement | Nlyte.Model.MountingPlacement | true | |
false
| | | | | | | |
MountingRotation | Nlyte.Model.MountingRotation | true | |
false
| | | | | | | |
MountingSide | Nlyte.Model.MountingSide | true | |
false
| | | | | | | |
UDisplayLabel | Edm.Int32 | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | The U label to be displayed, representing the top or the bottom U position, depending on the admin parameter |
UMountingID | Edm.Int32 | false | false |
true
| N/A | N/A | N/A | N/A | N/A | | Primary key identifying the UMounting entity |
XOffset | Edm.Double | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
XRotation | Edm.Double | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
YOffset | Edm.Double | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
YRotation | Edm.Double | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
ZOffset | Edm.Double | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
ZRotation | Edm.Double | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
UMounting Navigational Properties
Verb(s) | Required Permission(s) | Link | Description |
---|
Get | WS-ReadRoomPlan | | |
Patch | WS-ModifyRoomPlan | | |
Put | WS-ModifyRoomPlan | | |
Delete | WS-ModifyRoomPlan | | |
Post | WS-ModifyRoomPlan | | |
UnplacedRoom Structural Properties
Property | Type | Nullable | Mandatory | Read-Only | String length | Min Value | Max Value | Precision | Max Dec Places | Is Only Date | Description |
---|
Alias | Edm.String | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
FloorId | Edm.Int32 | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
FloorLocationGroupId | Edm.Int32 | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
Latitude | Edm.Decimal | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
LocationGroupId | Edm.Int32 | true | false |
true
| N/A | N/A | N/A | N/A | N/A | | |
Longitude | Edm.Decimal | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
Name | Edm.String | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
Tag | Edm.String | true | false |
false
| 40 | N/A | N/A | N/A | N/A | | |
UnplacedRoom Navigational Properties
UPS Entity
: Asset
- Asset created from a material of type UPS, entity inheriting the Nlyte.Model.Asset entity
Verb(s) | Required Permission(s) | Link | Description |
---|
Get | WS-ReadUPS | integration/api/odata/UPSs, integration/api/odata/UPSs({key}) | |
Patch | WS-ModifyUPS | integration/api/odata/UPSs({key}) | |
PostWithKey | WS-ModifyUPS | integration/api/odata/UPSs({key}) | |
Delete | WS-ModifyUPS | integration/api/odata/UPSs({key}) | |
Post | WS-AddUPS | integration/api/odata/UPSs | |
UPS Structural Properties
Property | Type | Nullable | Mandatory | Read-Only | String length | Min Value | Max Value | Precision | Max Dec Places | Is Only Date | Description |
---|
AuditDate | Edm.DateTimeOffset | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
AuditStatusCorrect | Edm.Boolean | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
AvailableAh | Edm.Decimal | true | false |
false
| N/A | 0 | 99999999.9999 | 12 | 4 | | |
BatteryInstallDate | Edm.DateTimeOffset | true | false |
false
| N/A | N/A | N/A | N/A | N/A | IsOnlyDate | |
CostPerUnitDay | Edm.Decimal | true | false |
false
| N/A | 0 | 999999.99 | 8 | 2 | | |
CurrentPowerFactor | Edm.Decimal | true | false |
true
| N/A | N/A | N/A | N/A | N/A | | Read-only property representing the percentage of power drawn by a PDD asset that is available to its consumers |
FixedCost | Edm.Decimal | true | false |
false
| N/A | 0 | 999999.99 | 8 | 2 | | |
IsMasterRedundancyDevice | Edm.Boolean | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | Value inserted by the user |
LastAuditorAccountID | Edm.Int32 | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
LastTestDate | Edm.DateTimeOffset | true | false |
false
| N/A | N/A | N/A | N/A | N/A | IsOnlyDate | |
MaxKVA | Edm.Decimal | true | false |
false
| N/A | 0 | 99999999.9999 | 12 | 4 | | |
NextTestDate | Edm.DateTimeOffset | true | false |
false
| N/A | N/A | N/A | N/A | N/A | IsOnlyDate | |
NumberOfBatteries | Edm.Int32 | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
OutputCount | Edm.Int32 | false | false |
true
| N/A | N/A | N/A | N/A | N/A | | |
PowerFactorOverride | Edm.Decimal | true | false |
false
| N/A | 0 | 1 | 3 | 2 | | Value provided by the user, overriding the CurrentPowerFactor value |
RealtimePowerFactor | Edm.Decimal | true | false |
true
| N/A | N/A | N/A | N/A | N/A | | Read-only value. |
UPS Navigational Properties
UPSMaterial Entity
: Material
- Material type inheriting properties from the base type
Verb(s) | Required Permission(s) | Link | Description |
---|
Get | WS-ReadUPSMaterial | integration/api/odata/UPSMaterials, integration/api/odata/UPSMaterials({key}) | |
Post | WS-AddUPSMaterial | integration/api/odata/UPSMaterials | |
PostWithKey | WS-ModifyUPSMaterial | | |
Patch | WS-ModifyUPSMaterial | integration/api/odata/UPSMaterials({key}) | |
Delete | WS-ModifyUPSMaterial | integration/api/odata/UPSMaterials({key}) | |
UPSMaterial Structural Properties
Property | Type | Nullable | Mandatory | Read-Only | String length | Min Value | Max Value | Precision | Max Dec Places | Is Only Date | Description |
---|
BatteryVoltage | Edm.Int32 | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
CalculatedMaxKW | Edm.Decimal | true | false |
true
| N/A | N/A | N/A | N/A | N/A | | |
DistributorPowerFactor | Edm.Decimal | false | false |
true
| N/A | N/A | N/A | N/A | N/A | | |
MaterialCategoryID | Edm.Int32 | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
MaxA | Edm.Decimal | true | false |
false
| N/A | 0 | 99999.999 | 8 | 3 | | |
MaxKVA | Edm.Decimal | true | false |
false
| N/A | 0 | 99999999.9999 | 12 | 4 | | |
MaxKW | Edm.Decimal | true | false |
false
| N/A | 0 | 99999999.9999 | 12 | 4 | | |
MaxV | Edm.Decimal | true | false |
false
| N/A | 0 | 99999.999 | 8 | 3 | | |
PowerBatteryTypeID | Nlyte.Model.PowerBatteryTypeEnum | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
PowerTypeID | Nlyte.Model.PowerTypeEnum | true | false |
true
| N/A | N/A | N/A | N/A | N/A | | Power type: phased or direct current |
UHeight | Edm.Int64 | false | false |
true
| N/A | N/A | N/A | N/A | N/A | | |
WorkableFootPrintFront | Edm.Double | false | false |
false
| N/A | 0 | 999999999999.9999 | 16 | 4 | | |
WorkableFootPrintHeight | Edm.Double | false | false |
false
| N/A | 0 | 999999999999.9999 | 16 | 4 | | |
WorkableFootPrintRear | Edm.Double | false | false |
false
| N/A | 0 | 999999999999.9999 | 16 | 4 | | |
UPSMaterial Navigational Properties
No navigational properties
Verb(s) | Required Permission(s) | Link | Description |
---|
UrlLinkControl Structural Properties
Property | Type | Nullable | Mandatory | Read-Only | String length | Min Value | Max Value | Precision | Max Dec Places | Is Only Date | Description |
---|
IncludeServiceRequestId | Edm.Boolean | false | true |
false
| N/A | N/A | N/A | N/A | N/A | | |
ParameterName | Edm.String | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
Text | Edm.String | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
Url | Edm.String | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
UrlLinkControl Navigational Properties
No navigational properties
Verb(s) | Required Permission(s) | Link | Description |
---|
UrlLinkControlValue Structural Properties
No structural properties
UrlLinkControlValue Navigational Properties
No navigational properties
Verb(s) | Required Permission(s) | Link | Description |
---|
UserAccount Structural Properties
Property | Type | Nullable | Mandatory | Read-Only | String length | Min Value | Max Value | Precision | Max Dec Places | Is Only Date | Description |
---|
ResourceID | Edm.Int32 | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
UserAccountID | Edm.Int32 | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
Username | Edm.String | false | true |
false
| 50 | N/A | N/A | N/A | N/A | | |
UserRoleID | Edm.Int32 | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
UserAccount Navigational Properties
Verb(s) | Required Permission(s) | Link | Description |
---|
Key(s) |
---|
UserAccountPermissionID |
UserAccountPermission Structural Properties
Property | Type | Nullable | Mandatory | Read-Only | String length | Min Value | Max Value | Precision | Max Dec Places | Is Only Date | Description |
---|
PermissionID | Edm.Int32 | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
State | Edm.Int32 | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
UserAccountID | Edm.Int32 | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
UserAccountPermissionID | Edm.Int32 | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
UserAccountPermission Navigational Properties
Verb(s) | Required Permission(s) | Link | Description |
---|
UserEffectivePermission Structural Properties
Property | Type | Nullable | Mandatory | Read-Only | String length | Min Value | Max Value | Precision | Max Dec Places | Is Only Date | Description |
---|
Name | Edm.String | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
State | Edm.Int32 | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
UserEffectivePermission Navigational Properties
No navigational properties
Verb(s) | Required Permission(s) | Link | Description |
---|
UserGroup Structural Properties
Property | Type | Nullable | Mandatory | Read-Only | String length | Min Value | Max Value | Precision | Max Dec Places | Is Only Date | Description |
---|
Detail | Edm.String | true | false |
false
| 255 | N/A | N/A | N/A | N/A | | User group description |
Email | Edm.String | true | false |
false
| 254 | N/A | N/A | N/A | N/A | | |
LdapUrl | Edm.String | true | false |
false
| 1024 | N/A | N/A | N/A | N/A | | |
UserGroupID | Edm.Int32 | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
UserGroup Navigational Properties
Verb(s) | Required Permission(s) | Link | Description |
---|
Key(s) |
---|
UserGroupPermissionID |
UserGroupPermission Structural Properties
Property | Type | Nullable | Mandatory | Read-Only | String length | Min Value | Max Value | Precision | Max Dec Places | Is Only Date | Description |
---|
PermissionID | Edm.Int32 | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
State | Edm.Int32 | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
UserGroupID | Edm.Int32 | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
UserGroupPermissionID | Edm.Int32 | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
UserGroupPermission Navigational Properties
Verb(s) | Required Permission(s) | Link | Description |
---|
Get | WS-ReadRoomPlan | | |
Patch | WS-ModifyRoomPlan | | |
Put | WS-ModifyRoomPlan | | |
Delete | WS-ModifyRoomPlan | | |
Post | WS-ModifyRoomPlan | | |
Wall Structural Properties
Property | Type | Nullable | Mandatory | Read-Only | String length | Min Value | Max Value | Precision | Max Dec Places | Is Only Date | Description |
---|
ID | Edm.Int32 | false | true |
false
| N/A | N/A | N/A | N/A | N/A | | |
LayerID | Edm.Int32 | true | true |
false
| N/A | N/A | N/A | N/A | N/A | | |
Name | Edm.String | true | false |
false
| 50 | N/A | N/A | N/A | N/A | | |
ParentLocationGroupID | Edm.Int32 | true | false |
true
| N/A | N/A | N/A | N/A | N/A | | |
PolygonID | Edm.Int32 | true | false |
true
| N/A | N/A | N/A | N/A | N/A | | |
SaveAction | Nlyte.Model.SaveActionEnum | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
Wall Navigational Properties
Verb(s) | Required Permission(s) | Link | Description |
---|
Warning Structural Properties
Property | Type | Nullable | Mandatory | Read-Only | String length | Min Value | Max Value | Precision | Max Dec Places | Is Only Date | Description |
---|
ID | Edm.Int32 | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
TaskContainerId | Edm.Int32 | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
WarningDescription | Edm.String | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
Warning Navigational Properties
No navigational properties
Verb(s) | Required Permission(s) | Link | Description |
---|
Warranty Structural Properties
Property | Type | Nullable | Mandatory | Read-Only | String length | Min Value | Max Value | Precision | Max Dec Places | Is Only Date | Description |
---|
AssetID | Edm.Int32 | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
Comments | Edm.String | true | false |
false
| 1000 | N/A | N/A | N/A | N/A | | |
ContractNumber | Edm.String | true | false |
false
| 40 | N/A | N/A | N/A | N/A | | |
DiscountEndDate | Edm.DateTimeOffset | true | false |
false
| N/A | N/A | N/A | N/A | N/A | IsOnlyDate | |
LeasePrice | Edm.String | true | false |
false
| 1000 | N/A | N/A | N/A | N/A | | |
PurchaseDate | Edm.DateTimeOffset | true | false |
false
| N/A | N/A | N/A | N/A | N/A | IsOnlyDate | |
RefNumber | Edm.String | true | false |
false
| 40 | N/A | N/A | N/A | N/A | | |
RenewalDate | Edm.DateTimeOffset | true | false |
false
| N/A | N/A | N/A | N/A | N/A | IsOnlyDate | |
Vendor | Edm.String | true | false |
false
| 1000 | N/A | N/A | N/A | N/A | | |
WarrantyCostCenter | Edm.String | true | false |
false
| 1000 | N/A | N/A | N/A | N/A | | |
WarrantyLevel | Edm.String | true | false |
false
| 1000 | N/A | N/A | N/A | N/A | | |
WarrantyStatus | Edm.String | true | false |
false
| 1000 | N/A | N/A | N/A | N/A | | |
Warranty Navigational Properties
Verb(s) | Required Permission(s) | Link | Description |
---|
Wire Structural Properties
Property | Type | Nullable | Mandatory | Read-Only | String length | Min Value | Max Value | Precision | Max Dec Places | Is Only Date | Description |
---|
AssetID | Edm.Int32 | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | The asset ID holding the wire, the power distributor asset |
AvailableKW | Edm.Decimal | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
CommittedKVA | Edm.Decimal | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
IsPowered | Edm.Boolean | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
Phase | Edm.Int32 | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
Position | Edm.Int32 | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | Wire position |
UnCommittedKW | Edm.Decimal | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
UsedKVA | Edm.Decimal | true | false |
false
| N/A | N/A | N/A | N/A | N/A | | Power load draw value for the wire |
WireID | Edm.Int32 | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
Wire Navigational Properties
Verb(s) | Required Permission(s) | Link | Description |
---|
WorkingHours Structural Properties
Property | Type | Nullable | Mandatory | Read-Only | String length | Min Value | Max Value | Precision | Max Dec Places | Is Only Date | Description |
---|
AssigneeID | Edm.Int32 | true | true |
false
| N/A | N/A | N/A | N/A | N/A | | |
EndTime | Edm.Int16 | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
Friday | Edm.Boolean | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
ID | Edm.Int32 | false | false |
true
| N/A | N/A | N/A | N/A | N/A | | |
Monday | Edm.Boolean | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
Saturday | Edm.Boolean | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
StartTime | Edm.Int16 | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
Sunday | Edm.Boolean | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
Thursday | Edm.Boolean | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
Tuesday | Edm.Boolean | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
Wednesday | Edm.Boolean | false | false |
false
| N/A | N/A | N/A | N/A | N/A | | |
WorkingHours Navigational Properties
Verb(s) | Required Permission(s) | Link | Description |
---|
Get | WS-ReadRoomPlan | | |
Patch | WS-ModifyRoomPlan | | |
Put | WS-ModifyRoomPlan | | |
Delete | WS-ModifyRoomPlan | | |
Post | WS-ModifyRoomPlan | | |
Zone Structural Properties
Property | Type | Nullable | Mandatory | Read-Only | String length | Min Value | Max Value | Precision | Max Dec Places | Is Only Date | Description |
---|
Name | Edm.String | true | false |
false
| 50 | N/A | N/A | N/A | N/A | | |
ParentLocationGroupID | Edm.Int32 | true | false |
true
| N/A | N/A | N/A | N/A | N/A | | |
RoomId | Edm.Int32 | true | false |
true
| N/A | N/A | N/A | N/A | N/A | | |
ZoneTypeId | Nlyte.Model.ZoneType | false | true |
false
| N/A | N/A | N/A | N/A | N/A | | |
Zone Navigational Properties
Verb(s) | Required Permission(s) | Link | Description |
---|
POST | WS-ModifyAirConditioningMaterial | integration/api/odata/AirConditioningMaterials({key}) | |
POST | WS-AddAirConditioningMaterial | integration/api/odata/AirConditioningMaterials | |
PATCH | WS-ModifyAirConditioningMaterial | integration/api/odata/AirConditioningMaterials({key}) | |
DELETE | WS-ModifyAirConditioningMaterial | integration/api/odata/AirConditioningMaterials({key}) | |
GET | WS-ReadAirConditioningMaterial | integration/api/odata/AirConditioningMaterials | |
GET | WS-ReadAirConditioningMaterial | integration/api/odata/AirConditioningMaterials({key}) | |
AirConditioningMaterials Actions
|
Action | Required Permission(s) | Link | Description |
---|
Cancel | WS-ModifyAirConditioningMaterial | integration/api/odata/AirConditioningMaterials({key})/Cancel | |
Activate | WS-ModifyAirConditioningMaterial | integration/api/odata/AirConditioningMaterials({key})/Activate | Function that will move a material in Active status. |
Deactivate | WS-ModifyAirConditioningMaterial | integration/api/odata/AirConditioningMaterials({key})/Deactivate | Function that will move a material in Inactive status. |
UploadFile | WS-AddFile | integration/api/odata/AirConditioningMaterials({key})/UploadFile(File={file}) | |
DeleteFile | WS-ModifyFile | integration/api/odata/AirConditioningMaterials({key})/DeleteFile(FileName={filename}) | |
AirConditioningMaterials Functions
|
Function | Required Permission(s) | Link | Description |
---|
DownloadFile | WS-ReadFile | integration/api/odata/AirConditioningMaterials({key})/DownloadFile(FileName={filename}) | |
GetAuditLogData | WS-ReadAuditLog | integration/api/odata/AirConditioningMaterials({key})/GetAuditLogData | Function used to export all audit information for a specific entity. Please use the following Content-Type:application/vnd.openxmlformats-officedocument.spreadsheetml.sheet for file download |
AirConditioningMaterials Custom Routes
|
CustomRoute | Required Permission(s) | Supported Method(s) | Description |
---|
integration/api/odata/AirConditioningMaterials/In(Ids={ids}) | |
GET
| |
integration/api/odata/AirConditioningMaterials/NotIn(Ids={ids}) | |
GET
| |
integration/api/odata/AirConditioningMaterials({key})/Files | |
DELETE
| |
AirConditioningMaterials Nested Properties
No nested properties
Verb(s) | Required Permission(s) | Link | Description |
---|
POST | WS-ModifyAirConditioning | integration/api/odata/AirConditionings({key}) | |
POST | WS-AddAirConditioning | integration/api/odata/AirConditionings | |
PATCH | WS-ModifyAirConditioning | integration/api/odata/AirConditionings({key}) | |
DELETE | WS-ModifyAirConditioning | integration/api/odata/AirConditionings({key}) | |
GET | WS-ReadAirConditioning | integration/api/odata/AirConditionings | |
GET | WS-ReadAirConditioning | integration/api/odata/AirConditionings({key}) | |
AirConditionings Actions
|
Action | Required Permission(s) | Link | Description |
---|
BeginMove | WS-PlanRecycleAirConditioning, WS-PlanDecommissionAirConditioning | integration/api/odata/AirConditionings({key})/BeginMove(RelocateType={relocatetype}) | Function that is used to move the selected asset in a planned state, Moving, Recycling or Decommissioning, depending on the RelocateType provided as parameter. The response contains the Planned AssetId. |
CancelMove | WS-CancelRecycleAirConditioning, WS-CancelDecommissionAirConditioning | integration/api/odata/AirConditionings({key})/CancelMove | Function that is used to cancel planned action. The selected asset will become Active/Operational. |
CompleteMove | WS-CompleteRecycleAirConditioning, WS-CompleteDecommissionAirConditioning | integration/api/odata/AirConditionings({key})/CompleteMove | Function that is used to finish planned action. The selected asset will become Active/Operational, Recycled/Available or Decommissioned/Decommissioned, depending on the Planned entity type (Move, Recycle or Deccommission). |
DirectMove | WS-SetLocationAirConditioning | integration/api/odata/AirConditionings({key})/DirectMove(RelocateType={relocatetype}, LocationGroupID={locationgroupid}) | Function that is used to directly move an asset to a new location in a final state. |
CompleteCreation | WS-ModifyAirConditioning | integration/api/odata/AirConditionings({key})/CompleteCreation | Function that moves an asset from Planned/(Pre)Procurement to Active/Operational. |
SetMaterial | | integration/api/odata/AirConditionings({key})/SetMaterial(NewMaterialID={newmaterialid}) | Function that is used to change the material on an existing asset. This action is only supported for Receptacles and Power Strips. |
AddRealTimeValues | WS-AddAssetRealtimeData | integration/api/odata/AirConditionings({key})/AddRealTimeValues(RealTimeInfo={realtimeinfo}, RealTimeValue={realtimevalue}) | Adds a provider specfic recorded real-time value against an asset or its associated outlet. Custom metrics are only allowed on assets whereas load, power and voltage metrics are allowed against assets, outlets or their relevant phases. |
AddNetworkAsset | WS-ReadNetworkConnection,WS-AddNetworkConnection | integration/api/odata/AirConditionings({key})/AddNetworkAsset(NetworkAssetId={networkassetid}) | Function that is adding the selected asset in the list of available asset to be used in network connections. The mapping between the two assets is created by providing the NetworkAssetId parameter in the BODY, NetworkAssetId representing the AssetID of the asset to be added in the list of available assets. |
RemoveNetworkAsset | WS-ModifyNetworkConnection | integration/api/odata/AirConditionings({key})/RemoveNetworkAsset(NetworkAssetId={networkassetid}, NetworkLinkerType={networklinkertype}) | Function that removes an asset from the association list of available asset to be used in network connections. |
UploadFile | WS-AddFile | integration/api/odata/AirConditionings({key})/UploadFile(File={file}) | |
DeleteFile | WS-ModifyFile | integration/api/odata/AirConditionings({key})/DeleteFile(FileName={filename}) | |
AirConditionings Functions
|
Function | Required Permission(s) | Link | Description |
---|
GetTotalSystemPowerConsumption | WS-ReadAirConditioning | integration/api/odata/AirConditionings({key})/GetTotalSystemPowerConsumption | Function that returns the TotalSystemPowerConsumption for the selected asset. |
GetRealTimePowerInfo | WS-ReadAirConditioning | integration/api/odata/AirConditionings({key})/GetRealTimePowerInfo | |
GetDiscoveryAssetPage | WS-ReadAirConditioning | integration/api/odata/AirConditionings({key})/GetDiscoveryAssetPage | Function that returns a collection of entities of type Nlyte.Model.AssetMapping. Used to determine external providers. |
RecordModifiedInfo | WS-ReadAirConditioning | integration/api/odata/AirConditionings({key})/RecordModifiedInfo | Function that returns an entity of type Nlyte.Model.AuditLogInfo and provides information regarding last modifications against the current asset |
GetMountedChildAssets | | integration/api/odata/AirConditionings({key})/GetMountedChildAssets(IncludeHosts={includehosts}, IncludeCards={includecards}) | Function that returns a collection of entities of type Nlyte.Model.MountedAssetSummary representing the list of mounted assets in the provided asset. The function is called as follows: Assets(AssetID)/GetMountedChildAssets(IncludeHosts=true,IncludeCards=true) where AssetID is the parent for which the children are retrieved. |
GetDistributorsWithFreeOutlets | WS-ReadAssetToAssetMapping | integration/api/odata/AirConditionings({key})/GetDistributorsWithFreeOutlets(SearchTerm={searchterm}, SearchTermOption={searchtermoption}, LocationDepth={locationdepth}, MaterialTypeID={materialtypeid}, MaterialSubtypeID={materialsubtypeid}) | Function that returns a collection of entities of type Nlyte.Model.Distributor representing available power suppliers. |
SearchAssetNetworkPortLinkage | WS-ReadNetworkConnection | integration/api/odata/AirConditionings({key})/SearchAssetNetworkPortLinkage(SearchTerm={searchterm}, SearchTermOption={searchtermoption}, CabinetMountingStatus={cabinetmountingstatus}, LocationTarget={locationtarget}, NetworkTypes={networktypes}, PortLocation={portlocation}) | Function that returns a collection of entities of type Nlyte.Model.AssetNetworkPortLinkage representing available assets to be used in network connections. |
GetRealTimeValues | WS-ReadAssetRealtimeData | integration/api/odata/AirConditionings({key})/GetRealTimeValues | Function that returns a collection of entities of type Nlyte.Model.RealTimeValue. |
GetAssetSummaries | | integration/api/odata/AirConditionings({key})/GetAssetSummaries(OwnedPeripherals={ownedperipherals}, IncludeHosts={includehosts}) | |
ListPowerConsumers | | integration/api/odata/AirConditionings({key})/ListPowerConsumers | Function that returns a collection of Nlyte.Model.Graph entities. Used to identify available Output Connector used in power connections. |
SupportsPlannedMove | | integration/api/odata/AirConditionings({key})/SupportsPlannedMove | |
GetTotalSystemWeight | | integration/api/odata/AirConditionings({key})/GetTotalSystemWeight | Function that returns the TotalSystemWeight for the selected asset. |
GetMountedOnAssetID | | integration/api/odata/AirConditionings({key})/GetMountedOnAssetID | |
GetAssetsReportData | WS-ReadNetwork,WS-ReadCabinet,WS-ReadPeripheral,WS-ReadKVMSwitch,WS-ReadServer,WS-ReadPDU,WS-ReadPowerStrip,WS-ReadAirConditioning,WS-ReadReceptacle,WS-ReadChassis,WS-ReadUPS,WS-ReadAuxiliary,WS-ReadStaticSwitch,WS-ReadServerHost | integration/api/odata/AirConditionings/GetAssetsReportData(assetIds={assetids}) | |
DownloadFile | WS-ReadFile | integration/api/odata/AirConditionings({key})/DownloadFile(FileName={filename}) | |
GetAuditLogData | WS-ReadAuditLog | integration/api/odata/AirConditionings({key})/GetAuditLogData | Function used to export all audit information for a specific entity. Please use the following Content-Type:application/vnd.openxmlformats-officedocument.spreadsheetml.sheet for file download |
AirConditionings Custom Routes
|
CustomRoute | Required Permission(s) | Supported Method(s) | Description |
---|
integration/api/odata/AirConditionings/In(Ids={ids}) | |
GET
| |
integration/api/odata/AirConditionings/NotIn(Ids={ids}) | |
GET
| |
integration/api/odata/AirConditionings({key})/Notes({relatedKey}) | |
GET
| |
integration/api/odata/AirConditionings({key})/Notes | |
GET
| |
integration/api/odata/AirConditionings({key})/Notes | |
POST
| |
integration/api/odata/AirConditionings({key})/Notes | |
DELETE
| |
integration/api/odata/AirConditionings({key})/Notes({relatedKey}) | |
DELETE
| |
integration/api/odata/AirConditionings({key})/Notes({relatedKey}) | |
PATCH
| |
integration/api/odata/AirConditionings({key})/Graphs | |
GET
| |
integration/api/odata/AirConditionings({key})/Graphs({relatedKey}) | |
GET
| |
integration/api/odata/AirConditionings({key})/Graphs({relatedKey}) | |
PATCH
| |
integration/api/odata/AirConditionings({key})/Graphs | |
POST
| |
integration/api/odata/AirConditionings({key})/Graphs({relatedKey}) | |
DELETE
| |
integration/api/odata/AirConditionings({key})/GetAvailableCabinetUs(CabinetID={cabinetId}) | WS-ReadCabinet |
GET
| |
integration/api/odata/AirConditionings({key})/GetServiceRequests | |
GET
| |
integration/api/odata/AirConditionings({key})/CustomFields | WS-ReadCustomFieldAirConditioning |
GET
| |
integration/api/odata/AirConditionings({key})/CustomFields | WS-ModifyCustomFieldAirConditioning |
POST
| |
integration/api/odata/AirConditionings({key})/CustomFields({relatedKey}) | WS-ModifyCustomFieldAirConditioning |
PATCH
| |
integration/api/odata/AirConditionings({key})/CustomFields({relatedKey}) | WS-ModifyCustomFieldAirConditioning |
DELETE
| |
integration/api/odata/AirConditionings({key})/Warranty | WS-ReadAirConditioning |
GET
| |
integration/api/odata/AirConditionings({key})/Warranty | WS-ModifyAirConditioning |
POST
| |
integration/api/odata/AirConditionings({key})/Warranty | WS-ModifyAirConditioning |
PATCH
| |
integration/api/odata/AirConditionings({key})/Warranty | WS-ModifyAirConditioning |
DELETE
| |
integration/api/odata/AirConditionings({key})/Maintenance | WS-ReadAirConditioning |
GET
| |
integration/api/odata/AirConditionings({key})/Maintenance | WS-ModifyAirConditioning |
POST
| |
integration/api/odata/AirConditionings({key})/Maintenance | WS-ModifyAirConditioning |
PATCH
| |
integration/api/odata/AirConditionings({key})/Maintenance | WS-ModifyAirConditioning |
DELETE
| |
integration/api/odata/AirConditionings({key})/AssetMounting | |
GET
| |
integration/api/odata/AirConditionings({key})/Ownership | WS-ReadBusinessGroupAssetMap |
GET
| |
integration/api/odata/AirConditionings({key})/Ownership({relatedKey}) | WS-ReadBusinessGroupAssetMap |
GET
| |
integration/api/odata/AirConditionings({key})/Ownership | WS-AddBusinessGroupAssetMap |
POST
| |
integration/api/odata/AirConditionings({key})/Ownership({relatedKey}) | WS-ModifyBusinessGroupAssetMap |
PATCH
| |
integration/api/odata/AirConditionings({key})/Ownership({relatedKey}) | WS-ModifyBusinessGroupAssetMap |
DELETE
| |
integration/api/odata/AirConditionings({key})/Support | WS-ReadSupportGroupAssetMap |
GET
| |
integration/api/odata/AirConditionings({key})/Support({relatedKey}) | WS-ReadSupportGroupAssetMap |
GET
| |
integration/api/odata/AirConditionings({key})/Support | WS-AddSupportGroupAssetMap |
POST
| |
integration/api/odata/AirConditionings({key})/Support({relatedKey}) | WS-ModifySupportGroupAssetMap |
PATCH
| |
integration/api/odata/AirConditionings({key})/Support({relatedKey}) | WS-ModifySupportGroupAssetMap |
DELETE
| |
integration/api/odata/AirConditionings({key})/AssociatedAssets({relatedKey}) | |
DELETE
| |
integration/api/odata/AirConditionings({key})/AssociatedAssets({relatedKey})/Notes({nestedRelatedKey}) | |
GET
| |
integration/api/odata/AirConditionings({key})/AssociatedAssets({relatedKey})/Notes | |
GET
| |
integration/api/odata/AirConditionings({key})/AssociatedAssets({relatedKey})/Notes({nestedRelatedKey}) | |
PATCH
| |
integration/api/odata/AirConditionings({key})/AssociatedAssets({relatedKey})/Notes | |
POST
| |
integration/api/odata/AirConditionings({key})/AssociatedAssets({relatedKey})/Notes | |
DELETE
| |
integration/api/odata/AirConditionings({key})/AssociatedAssets({relatedKey})/Notes({nestedRelatedKey}) | |
DELETE
| |
integration/api/odata/AirConditionings({key})/Files | |
DELETE
| |
AirConditionings Nested Properties
|
NestedProperty | Supported Method(s) |
---|
Ownership |
BIND
POST
PATCH
|
Support |
BIND
POST
PATCH
|
CustomFields |
POST
PATCH
|
Maintenance |
POST
PATCH
|
Warranty |
POST
PATCH
|
AssetIPAddressMap |
POST
PATCH
|
LocationGroup | |
AssociatedAssets |
BIND
|
InputConnectors |
PATCH
|
Graphs |
POST
PATCH
|
UMounting |
POST
PATCH
|
Verb(s) | Required Permission(s) | Link | Description |
---|
GET | WS-ReadAssetRealtimeData | integration/api/odata/AssetRealTimeData | |
GET | WS-ReadAssetRealtimeData | integration/api/odata/AssetRealTimeData({key}) | |
AssetRealTimeData Actions
No actions
AssetRealTimeData Functions
No functions
AssetRealTimeData Custom Routes
|
CustomRoute | Required Permission(s) | Supported Method(s) | Description |
---|
integration/api/odata/Cultures/In(Ids={ids}) | |
GET
| |
integration/api/odata/Cultures/NotIn(Ids={ids}) | |
GET
| |
AssetRealTimeData Nested Properties
No nested properties
Verb(s) | Required Permission(s) | Link | Description |
---|
GET | WS-ReadAssetRealtimePhaseData | integration/api/odata/AssetRealTimePhaseData | |
GET | WS-ReadAssetRealtimePhaseData | integration/api/odata/AssetRealTimePhaseData({key}) | |
AssetRealTimePhaseData Actions
No actions
AssetRealTimePhaseData Functions
No functions
AssetRealTimePhaseData Custom Routes
|
CustomRoute | Required Permission(s) | Supported Method(s) | Description |
---|
integration/api/odata/Cultures/In(Ids={ids}) | |
GET
| |
integration/api/odata/Cultures/NotIn(Ids={ids}) | |
GET
| |
AssetRealTimePhaseData Nested Properties
No nested properties
Verb(s) | Required Permission(s) | Link | Description |
---|
POST | | integration/api/odata/Assets | |
POST | | integration/api/odata/Assets({key}) | |
PATCH | | integration/api/odata/Assets({key}) | |
DELETE | | integration/api/odata/Assets({key}) | |
GET | WS-ReadCabinet,WS-ReadServer,WS-ReadUPS,WS-ReadNetwork,WS-ReadPeripheral,WS-ReadStaticSwitch,WS-ReadReceptacle,WS-ReadKVMSwitch,WS-ReadAuxiliary,WS-ReadAirConditioning,WS-ReadChassis,WS-ReadPDU,WS-ReadPowerStrip | integration/api/odata/Assets | |
GET | WS-ReadCabinet,WS-ReadServer,WS-ReadUPS,WS-ReadNetwork,WS-ReadPeripheral,WS-ReadStaticSwitch,WS-ReadReceptacle,WS-ReadKVMSwitch,WS-ReadAuxiliary,WS-ReadAirConditioning,WS-ReadChassis,WS-ReadPDU,WS-ReadPowerStrip | integration/api/odata/Assets({key}) | |
Assets Actions
|
Action | Required Permission(s) | Link | Description |
---|
SetMaterial | | integration/api/odata/Assets({key})/SetMaterial(NewMaterialID={newmaterialid}) | Function that is used to change the material on an existing asset. This action is only supported for Receptacles and Power Strips. |
BeginMove | | integration/api/odata/Assets({key})/BeginMove(RelocateType={relocatetype}) | Function that is used to move the selected asset in a planned state, Moving, Recycling or Decommissioning, depending on the RelocateType provided as parameter. The response contains the Planned AssetId. |
CompleteMove | | integration/api/odata/Assets({key})/CompleteMove | Function that is used to finish planned action. The selected asset will become Active/Operational, Recycled/Available or Decommissioned/Decommissioned, depending on the Planned entity type (Move, Recycle or Deccommission). |
CancelMove | | integration/api/odata/Assets({key})/CancelMove | Function that is used to cancel planned action. The selected asset will become Active/Operational. |
DirectMove | | integration/api/odata/Assets({key})/DirectMove(RelocateType={relocatetype}, LocationGroupID={locationgroupid}) | Function that is used to directly move an asset to a new location in a final state. |
AddNetworkAsset | WS-ReadNetworkConnection,WS-AddNetworkConnection | integration/api/odata/Assets({key})/AddNetworkAsset(NetworkAssetId={networkassetid}) | Function that is adding the selected asset in the list of available asset to be used in network connections. The mapping between the two assets is created by providing the NetworkAssetId parameter in the BODY, NetworkAssetId representing the AssetID of the asset to be added in the list of available assets. |
RemoveNetworkAsset | WS-ModifyNetworkConnection | integration/api/odata/Assets({key})/RemoveNetworkAsset(NetworkAssetId={networkassetid}, NetworkLinkerType={networklinkertype}) | Function that removes an asset from the association list of available asset to be used in network connections. |
CompleteCreation | | integration/api/odata/Assets({key})/CompleteCreation | Function that moves an asset from Planned/(Pre)Procurement to Active/Operational. |
UploadFile | WS-AddFile | integration/api/odata/Assets({key})/UploadFile(File={file}) | |
DeleteFile | WS-ModifyFile | integration/api/odata/Assets({key})/DeleteFile(FileName={filename}) | |
Assets Functions
|
Function | Required Permission(s) | Link | Description |
---|
ListLinkedRecords | WS-ReadServerHost, WS-ReadPeripheral | integration/api/odata/Assets/ListLinkedRecords(assetIds={assetids}) | |
HasTraceConnections | WS-ReadNetworkConnection, WS-ReadAssetToAssetMapping | integration/api/odata/Assets({key})/HasTraceConnections | |
GetNetworkAndPowerConnections | WS-ReadNetworkConnection, WS-ReadAssetToAssetMapping | integration/api/odata/Assets({key})/GetNetworkAndPowerConnections(filters={filters}, filterAssetIDs={filterassetids}, showPowerChain={showpowerchain}, groupChassis={groupchassis}) | |
GetNetworkAndPowerConnectionsForExport | WS-ReadNetworkConnection, WS-ReadAssetToAssetMapping | integration/api/odata/Assets({key})/GetNetworkAndPowerConnectionsForExport(filters={filters}, filterAssetIDs={filterassetids}, showPowerChain={showpowerchain}) | |
GetMountedChildAssets | | integration/api/odata/Assets({key})/GetMountedChildAssets(IncludeHosts={includehosts}, IncludeCards={includecards}) | Function that returns a collection of entities of type Nlyte.Model.MountedAssetSummary representing the list of mounted assets in the provided asset. The function is called as follows: Assets(AssetID)/GetMountedChildAssets(IncludeHosts=true,IncludeCards=true) where AssetID is the parent for which the children are retrieved. |
GetDistributorsWithFreeOutlets | WS-ReadAssetToAssetMapping | integration/api/odata/Assets({key})/GetDistributorsWithFreeOutlets(SearchTerm={searchterm}, SearchTermOption={searchtermoption}, LocationDepth={locationdepth}, MaterialTypeID={materialtypeid}, MaterialSubtypeID={materialsubtypeid}) | Function that returns a collection of entities of type Nlyte.Model.Distributor representing available power suppliers. |
SearchAssetNetworkPortLinkage | WS-ReadNetworkConnection | integration/api/odata/Assets({key})/SearchAssetNetworkPortLinkage(SearchTerm={searchterm}, SearchTermOption={searchtermoption}, CabinetMountingStatus={cabinetmountingstatus}, LocationTarget={locationtarget}, NetworkTypes={networktypes}, PortLocation={portlocation}) | Function that returns a collection of entities of type Nlyte.Model.AssetNetworkPortLinkage representing available assets to be used in network connections. |
ListPowerConsumers | | integration/api/odata/Assets({key})/ListPowerConsumers | Function that returns a collection of Nlyte.Model.Graph entities. Used to identify available Output Connector used in power connections. |
GetDiscoveryAssetPage | | integration/api/odata/Assets({key})/GetDiscoveryAssetPage | Function that returns a collection of entities of type Nlyte.Model.AssetMapping. Used to determine external providers. |
GetAssetsReportData | WS-ReadNetwork,WS-ReadCabinet,WS-ReadPeripheral,WS-ReadKVMSwitch,WS-ReadServer,WS-ReadPDU,WS-ReadPowerStrip,WS-ReadAirConditioning,WS-ReadReceptacle,WS-ReadChassis,WS-ReadUPS,WS-ReadAuxiliary,WS-ReadStaticSwitch,WS-ReadServerHost | integration/api/odata/Assets/GetAssetsReportData(assetIds={assetids}) | |
DownloadFile | WS-ReadFile | integration/api/odata/Assets({key})/DownloadFile(FileName={filename}) | |
Assets Custom Routes
|
CustomRoute | Required Permission(s) | Supported Method(s) | Description |
---|
integration/api/odata/IgnoreWarningsAndCommit | |
POST
| |
integration/api/odata/Assets/In(Ids={ids}) | |
GET
| |
integration/api/odata/Assets/NotIn(Ids={ids}) | |
GET
| |
integration/api/odata/Assets({key})/Files | |
DELETE
| |
Assets Nested Properties
|
NestedProperty | Supported Method(s) |
---|
Ownership |
BIND
POST
PATCH
|
Support |
BIND
POST
PATCH
|
CustomFields |
POST
PATCH
|
Maintenance |
POST
PATCH
|
Warranty |
POST
PATCH
|
AssetIPAddressMap |
POST
PATCH
|
LocationGroup | |
AssociatedAssets |
BIND
|
Verb(s) | Required Permission(s) | Link | Description |
---|
GET | WS-ReadCabinet,WS-ReadServer,WS-ReadUPS,WS-ReadNetwork,WS-ReadPeripheral,WS-ReadStaticSwitch,WS-ReadReceptacle,WS-ReadKVMSwitch,WS-ReadAuxiliary,WS-ReadAirConditioning,WS-ReadChassis,WS-ReadPDU,WS-ReadPowerStrip,WS-ReadServerHost | integration/api/odata/AssetsAndHosts | |
GET | WS-ReadCabinet,WS-ReadServer,WS-ReadUPS,WS-ReadNetwork,WS-ReadPeripheral,WS-ReadStaticSwitch,WS-ReadReceptacle,WS-ReadKVMSwitch,WS-ReadAuxiliary,WS-ReadAirConditioning,WS-ReadChassis,WS-ReadPDU,WS-ReadPowerStrip,WS-ReadServerHost | integration/api/odata/AssetsAndHosts({key}) | |
AssetsAndHosts Actions
No actions
AssetsAndHosts Functions
No functions
AssetsAndHosts Custom Routes
|
CustomRoute | Required Permission(s) | Supported Method(s) | Description |
---|
integration/api/odata/AssetsAndHosts/In(Ids={ids}) | |
GET
| |
integration/api/odata/AssetsAndHosts/NotIn(Ids={ids}) | |
GET
| |
AssetsAndHosts Nested Properties
No nested properties
Verb(s) | Required Permission(s) | Link | Description |
---|
POST | WS-BeginInstantiateTemplate | integration/api/odata/AssetTemplateInstances | |
GET | | integration/api/odata/AssetTemplateInstances | |
GET | | integration/api/odata/AssetTemplateInstances({key}) | |
AssetTemplateInstances Actions
No actions
AssetTemplateInstances Functions
No functions
AssetTemplateInstances Custom Routes
No custom routes
AssetTemplateInstances Nested Properties
No nested properties
Verb(s) | Required Permission(s) | Link | Description |
---|
GET | WS-ReadAssetTemplate | integration/api/odata/AssetTemplateJobs | |
GET | WS-ReadAssetTemplate | integration/api/odata/AssetTemplateJobs({key}) | |
AssetTemplateJobs Actions
No actions
AssetTemplateJobs Functions
No functions
AssetTemplateJobs Custom Routes
|
CustomRoute | Required Permission(s) | Supported Method(s) | Description |
---|
integration/api/odata/AssetTemplateJobs({key})/WithNoLock | |
GET
| |
integration/api/odata/AssetTemplateJobs/In(Ids={ids}) | |
GET
| |
integration/api/odata/AssetTemplateJobs/NotIn(Ids={ids}) | |
GET
| |
integration/api/odata/AssetTemplateJobs({key})/Cancel | WS-CancelInstantiateTemplate |
POST
| |
integration/api/odata/AssetTemplateJobs({jobid})/Complete | WS-BeginInstantiateTemplate |
POST
| |
AssetTemplateJobs Nested Properties
No nested properties
Verb(s) | Required Permission(s) | Link | Description |
---|
POST | WS-AddAssetTemplate | integration/api/odata/AssetTemplates | |
PATCH | WS-ModifyAssetTemplate | integration/api/odata/AssetTemplates({key}) | |
GET | WS-ReadAssetTemplate | integration/api/odata/AssetTemplates | |
GET | WS-ReadAssetTemplate | integration/api/odata/AssetTemplates({key}) | |
AssetTemplates Actions
|
Action | Required Permission(s) | Link | Description |
---|
GetReportForExport | WS-ReadAssetTemplate | integration/api/odata/AssetTemplates({key})/GetReportForExport | Used to export values related to the selected template. Please use the following mimeType for excel export application/vnd.openxmlformats-officedocument.spreadsheetml.sheet |
AssetTemplates Functions
|
Function | Required Permission(s) | Link | Description |
---|
GetTemplateRootAssets | WS-ReadAssetTemplate | integration/api/odata/AssetTemplates({key})/GetTemplateRootAssets(IncludeHosts={includehosts}, IncludeCards={includecards}) | |
AssetTemplates Custom Routes
|
CustomRoute | Required Permission(s) | Supported Method(s) | Description |
---|
integration/api/odata/AssetTemplates/In(Ids={ids}) | |
GET
| |
integration/api/odata/AssetTemplates/NotIn(Ids={ids}) | |
GET
| |
integration/api/odata/AssetTemplates({key})/Activate | WS-ModifyAssetTemplate |
POST
| |
integration/api/odata/AssetTemplates({key})/Deactivate | WS-ModifyAssetTemplate |
POST
| |
AssetTemplates Nested Properties
No nested properties
Verb(s) | Required Permission(s) | Link | Description |
---|
POST | WS-AssetUpload | integration/api/odata/AssetUploaderJobs | |
DELETE | WS-AssetUpload | integration/api/odata/AssetUploaderJobs({key}) | |
GET | WS-AssetUpload | integration/api/odata/AssetUploaderJobs | |
GET | WS-AssetUpload | integration/api/odata/AssetUploaderJobs({key}) | |
AssetUploaderJobs Actions
No actions
AssetUploaderJobs Functions
|
Function | Required Permission(s) | Link | Description |
---|
DownloadFile | WS-AssetUpload | integration/api/odata/AssetUploaderJobs({key})/DownloadFile(FileName={filename}) | |
AssetUploaderJobs Custom Routes
|
CustomRoute | Required Permission(s) | Supported Method(s) | Description |
---|
integration/api/odata/AssetUploaderJobs({key})/WithNoLock | |
GET
| |
integration/api/odata/AssetUploaderJobs/In(Ids={ids}) | |
GET
| |
integration/api/odata/AssetUploaderJobs/NotIn(Ids={ids}) | |
GET
| |
integration/api/odata/AssetUploaderJobs({key})/Cancel | WS-AssetUpload |
POST
| |
AssetUploaderJobs Nested Properties
No nested properties
Verb(s) | Required Permission(s) | Link | Description |
---|
GET | | integration/api/odata/Assignees | |
GET | | integration/api/odata/Assignees({key}) | |
Assignees Actions
No actions
Assignees Functions
No functions
Assignees Custom Routes
|
CustomRoute | Required Permission(s) | Supported Method(s) | Description |
---|
integration/api/odata/Assignees/In(Ids={ids}) | |
GET
| |
integration/api/odata/Assignees/NotIn(Ids={ids}) | |
GET
| |
Assignees Nested Properties
No nested properties
Verb(s) | Required Permission(s) | Link | Description |
---|
POST | WS-ModifyAuxiliary | integration/api/odata/Auxiliaries({key}) | |
POST | WS-AddAuxiliary | integration/api/odata/Auxiliaries | |
PATCH | WS-ModifyAuxiliary | integration/api/odata/Auxiliaries({key}) | |
DELETE | WS-ModifyAuxiliary | integration/api/odata/Auxiliaries({key}) | |
GET | WS-ReadAuxiliary | integration/api/odata/Auxiliaries | |
GET | WS-ReadAuxiliary | integration/api/odata/Auxiliaries({key}) | |
Auxiliaries Actions
|
Action | Required Permission(s) | Link | Description |
---|
BeginMove | WS-PlanRecycleAuxiliary, WS-PlanDecommissionAuxiliary | integration/api/odata/Auxiliaries({key})/BeginMove(RelocateType={relocatetype}) | Function that is used to move the selected asset in a planned state, Moving, Recycling or Decommissioning, depending on the RelocateType provided as parameter. The response contains the Planned AssetId. |
CancelMove | WS-CancelRecycleAuxiliary, WS-CancelDecommissionAuxiliary | integration/api/odata/Auxiliaries({key})/CancelMove | Function that is used to cancel planned action. The selected asset will become Active/Operational. |
CompleteMove | WS-CompleteRecycleAuxiliary, WS-CompleteDecommissionAuxiliary | integration/api/odata/Auxiliaries({key})/CompleteMove | Function that is used to finish planned action. The selected asset will become Active/Operational, Recycled/Available or Decommissioned/Decommissioned, depending on the Planned entity type (Move, Recycle or Deccommission). |
DirectMove | WS-SetLocationAuxiliary | integration/api/odata/Auxiliaries({key})/DirectMove(RelocateType={relocatetype}, LocationGroupID={locationgroupid}) | Function that is used to directly move an asset to a new location in a final state. |
CompleteCreation | WS-ModifyAuxiliary | integration/api/odata/Auxiliaries({key})/CompleteCreation | Function that moves an asset from Planned/(Pre)Procurement to Active/Operational. |
SetMaterial | | integration/api/odata/Auxiliaries({key})/SetMaterial(NewMaterialID={newmaterialid}) | Function that is used to change the material on an existing asset. This action is only supported for Receptacles and Power Strips. |
AddRealTimeValues | WS-AddAssetRealtimeData | integration/api/odata/Auxiliaries({key})/AddRealTimeValues(RealTimeInfo={realtimeinfo}, RealTimeValue={realtimevalue}) | Adds a provider specfic recorded real-time value against an asset or its associated outlet. Custom metrics are only allowed on assets whereas load, power and voltage metrics are allowed against assets, outlets or their relevant phases. |
AddNetworkAsset | WS-ReadNetworkConnection,WS-AddNetworkConnection | integration/api/odata/Auxiliaries({key})/AddNetworkAsset(NetworkAssetId={networkassetid}) | Function that is adding the selected asset in the list of available asset to be used in network connections. The mapping between the two assets is created by providing the NetworkAssetId parameter in the BODY, NetworkAssetId representing the AssetID of the asset to be added in the list of available assets. |
RemoveNetworkAsset | WS-ModifyNetworkConnection | integration/api/odata/Auxiliaries({key})/RemoveNetworkAsset(NetworkAssetId={networkassetid}, NetworkLinkerType={networklinkertype}) | Function that removes an asset from the association list of available asset to be used in network connections. |
UploadFile | WS-AddFile | integration/api/odata/Auxiliaries({key})/UploadFile(File={file}) | |
DeleteFile | WS-ModifyFile | integration/api/odata/Auxiliaries({key})/DeleteFile(FileName={filename}) | |
Auxiliaries Functions
|
Function | Required Permission(s) | Link | Description |
---|
GetTotalSystemPowerConsumption | WS-ReadAuxiliary | integration/api/odata/Auxiliaries({key})/GetTotalSystemPowerConsumption | Function that returns the TotalSystemPowerConsumption for the selected asset. |
GetRealTimePowerInfo | WS-ReadAuxiliary | integration/api/odata/Auxiliaries({key})/GetRealTimePowerInfo | |
GetDiscoveryAssetPage | WS-ReadAuxiliary | integration/api/odata/Auxiliaries({key})/GetDiscoveryAssetPage | Function that returns a collection of entities of type Nlyte.Model.AssetMapping. Used to determine external providers. |
RecordModifiedInfo | WS-ReadAuxiliary | integration/api/odata/Auxiliaries({key})/RecordModifiedInfo | Function that returns an entity of type Nlyte.Model.AuditLogInfo and provides information regarding last modifications against the current asset |
GetMountedChildAssets | | integration/api/odata/Auxiliaries({key})/GetMountedChildAssets(IncludeHosts={includehosts}, IncludeCards={includecards}) | Function that returns a collection of entities of type Nlyte.Model.MountedAssetSummary representing the list of mounted assets in the provided asset. The function is called as follows: Assets(AssetID)/GetMountedChildAssets(IncludeHosts=true,IncludeCards=true) where AssetID is the parent for which the children are retrieved. |
GetDistributorsWithFreeOutlets | WS-ReadAssetToAssetMapping | integration/api/odata/Auxiliaries({key})/GetDistributorsWithFreeOutlets(SearchTerm={searchterm}, SearchTermOption={searchtermoption}, LocationDepth={locationdepth}, MaterialTypeID={materialtypeid}, MaterialSubtypeID={materialsubtypeid}) | Function that returns a collection of entities of type Nlyte.Model.Distributor representing available power suppliers. |
SearchAssetNetworkPortLinkage | WS-ReadNetworkConnection | integration/api/odata/Auxiliaries({key})/SearchAssetNetworkPortLinkage(SearchTerm={searchterm}, SearchTermOption={searchtermoption}, CabinetMountingStatus={cabinetmountingstatus}, LocationTarget={locationtarget}, NetworkTypes={networktypes}, PortLocation={portlocation}) | Function that returns a collection of entities of type Nlyte.Model.AssetNetworkPortLinkage representing available assets to be used in network connections. |
GetRealTimeValues | WS-ReadAssetRealtimeData | integration/api/odata/Auxiliaries({key})/GetRealTimeValues | Function that returns a collection of entities of type Nlyte.Model.RealTimeValue. |
GetAssetSummaries | | integration/api/odata/Auxiliaries({key})/GetAssetSummaries(OwnedPeripherals={ownedperipherals}, IncludeHosts={includehosts}) | |
GetNetworkCardPortsInfo | WS-ReadNetworkConnection | integration/api/odata/Auxiliaries({key})/GetNetworkCardPortsInfo | Returns an object of type Nlyte.Model.NetworkResults having information about Copper and Fiber Ports |
GetNetworkCardPortConnections | WS-ReadNetworkConnection | integration/api/odata/Auxiliaries({key})/GetNetworkCardPortConnections | Returns an object of type Nlyte.Model.NetworkResults having information about Copper and Fiber Port connections |
GetNetworkAssetSummary | WS-ReadNetworkConnection | integration/api/odata/Auxiliaries({key})/GetNetworkAssetSummary | Returns an object of type Nlyte.Model.NetworkResults having information about the networkable assets. |
ListPowerConsumers | | integration/api/odata/Auxiliaries({key})/ListPowerConsumers | Function that returns a collection of Nlyte.Model.Graph entities. Used to identify available Output Connector used in power connections. |
SupportsPlannedMove | | integration/api/odata/Auxiliaries({key})/SupportsPlannedMove | |
GetTotalSystemWeight | | integration/api/odata/Auxiliaries({key})/GetTotalSystemWeight | Function that returns the TotalSystemWeight for the selected asset. |
GetMountedOnAssetID | | integration/api/odata/Auxiliaries({key})/GetMountedOnAssetID | |
GetAssetsReportData | WS-ReadNetwork,WS-ReadCabinet,WS-ReadPeripheral,WS-ReadKVMSwitch,WS-ReadServer,WS-ReadPDU,WS-ReadPowerStrip,WS-ReadAirConditioning,WS-ReadReceptacle,WS-ReadChassis,WS-ReadUPS,WS-ReadAuxiliary,WS-ReadStaticSwitch,WS-ReadServerHost | integration/api/odata/Auxiliaries/GetAssetsReportData(assetIds={assetids}) | |
DownloadFile | WS-ReadFile | integration/api/odata/Auxiliaries({key})/DownloadFile(FileName={filename}) | |
GetAuditLogData | WS-ReadAuditLog | integration/api/odata/Auxiliaries({key})/GetAuditLogData | Function used to export all audit information for a specific entity. Please use the following Content-Type:application/vnd.openxmlformats-officedocument.spreadsheetml.sheet for file download |
Auxiliaries Custom Routes
|
CustomRoute | Required Permission(s) | Supported Method(s) | Description |
---|
integration/api/odata/Auxiliaries({key})/Wires | |
GET
| |
integration/api/odata/Auxiliaries({key})/Notes({relatedKey}) | |
GET
| |
integration/api/odata/Auxiliaries({key})/Notes | |
GET
| |
integration/api/odata/Auxiliaries({key})/Notes | |
POST
| |
integration/api/odata/Auxiliaries({key})/Notes | |
DELETE
| |
integration/api/odata/Auxiliaries({key})/Notes({relatedKey}) | |
DELETE
| |
integration/api/odata/Auxiliaries({key})/Notes({relatedKey}) | |
PATCH
| |
integration/api/odata/Auxiliaries({key})/Utilities | |
GET
| |
integration/api/odata/Auxiliaries({key})/Utilities({relatedKey}) | |
GET
| |
integration/api/odata/Auxiliaries({key})/Utilities({relatedKey}) | |
DELETE
| |
integration/api/odata/Auxiliaries({key})/Graphs | |
GET
| |
integration/api/odata/Auxiliaries({key})/Graphs({relatedKey}) | |
GET
| |
integration/api/odata/Auxiliaries({key})/Graphs({relatedKey}) | |
PATCH
| |
integration/api/odata/Auxiliaries({key})/Graphs | |
POST
| |
integration/api/odata/Auxiliaries({key})/Graphs({relatedKey}) | |
DELETE
| |
integration/api/odata/Auxiliaries({key})/GetAvailableCabinetUs(CabinetID={cabinetId}) | WS-ReadCabinet |
GET
| |
integration/api/odata/Auxiliaries({key})/GetServiceRequests | |
GET
| |
integration/api/odata/Auxiliaries({key})/CustomFields | WS-ReadCustomFieldAuxiliary |
GET
| |
integration/api/odata/Auxiliaries({key})/CustomFields | WS-ModifyCustomFieldAuxiliary |
POST
| |
integration/api/odata/Auxiliaries({key})/CustomFields({relatedKey}) | WS-ModifyCustomFieldAuxiliary |
PATCH
| |
integration/api/odata/Auxiliaries({key})/CustomFields({relatedKey}) | WS-ModifyCustomFieldAuxiliary |
DELETE
| |
integration/api/odata/Auxiliaries({key})/Warranty | WS-ReadAuxiliary |
GET
| |
integration/api/odata/Auxiliaries({key})/Warranty | WS-ModifyAuxiliary |
POST
| |
integration/api/odata/Auxiliaries({key})/Warranty | WS-ModifyAuxiliary |
PATCH
| |
integration/api/odata/Auxiliaries({key})/Warranty | WS-ModifyAuxiliary |
DELETE
| |
integration/api/odata/Auxiliaries({key})/Maintenance | WS-ReadAuxiliary |
GET
| |
integration/api/odata/Auxiliaries({key})/Maintenance | WS-ModifyAuxiliary |
POST
| |
integration/api/odata/Auxiliaries({key})/Maintenance | WS-ModifyAuxiliary |
PATCH
| |
integration/api/odata/Auxiliaries({key})/Maintenance | WS-ModifyAuxiliary |
DELETE
| |
integration/api/odata/Auxiliaries({key})/AssetMounting | |
GET
| |
integration/api/odata/Auxiliaries({key})/Ownership | WS-ReadBusinessGroupAssetMap |
GET
| |
integration/api/odata/Auxiliaries({key})/Ownership({relatedKey}) | WS-ReadBusinessGroupAssetMap |
GET
| |
integration/api/odata/Auxiliaries({key})/Ownership | WS-AddBusinessGroupAssetMap |
POST
| |
integration/api/odata/Auxiliaries({key})/Ownership({relatedKey}) | WS-ModifyBusinessGroupAssetMap |
PATCH
| |
integration/api/odata/Auxiliaries({key})/Ownership({relatedKey}) | WS-ModifyBusinessGroupAssetMap |
DELETE
| |
integration/api/odata/Auxiliaries({key})/Support | WS-ReadSupportGroupAssetMap |
GET
| |
integration/api/odata/Auxiliaries({key})/Support({relatedKey}) | WS-ReadSupportGroupAssetMap |
GET
| |
integration/api/odata/Auxiliaries({key})/Support | WS-AddSupportGroupAssetMap |
POST
| |
integration/api/odata/Auxiliaries({key})/Support({relatedKey}) | WS-ModifySupportGroupAssetMap |
PATCH
| |
integration/api/odata/Auxiliaries({key})/Support({relatedKey}) | WS-ModifySupportGroupAssetMap |
DELETE
| |
integration/api/odata/Auxiliaries({key})/AssociatedAssets({relatedKey}) | |
DELETE
| |
integration/api/odata/Auxiliaries({key})/AssociatedAssets({relatedKey})/Notes({nestedRelatedKey}) | |
GET
| |
integration/api/odata/Auxiliaries({key})/AssociatedAssets({relatedKey})/Notes | |
GET
| |
integration/api/odata/Auxiliaries({key})/AssociatedAssets({relatedKey})/Notes({nestedRelatedKey}) | |
PATCH
| |
integration/api/odata/Auxiliaries({key})/AssociatedAssets({relatedKey})/Notes | |
POST
| |
integration/api/odata/Auxiliaries({key})/AssociatedAssets({relatedKey})/Notes | |
DELETE
| |
integration/api/odata/Auxiliaries({key})/AssociatedAssets({relatedKey})/Notes({nestedRelatedKey}) | |
DELETE
| |
integration/api/odata/Auxiliaries/In(Ids={ids}) | |
GET
| |
integration/api/odata/Auxiliaries/NotIn(Ids={ids}) | |
GET
| |
integration/api/odata/Auxiliaries({key})/Files | |
DELETE
| |
Auxiliaries Nested Properties
|
NestedProperty | Supported Method(s) |
---|
Ownership |
BIND
POST
PATCH
|
Support |
BIND
POST
PATCH
|
CustomFields |
POST
PATCH
|
Maintenance |
POST
PATCH
|
Warranty |
POST
PATCH
|
AssetIPAddressMap |
POST
PATCH
|
LocationGroup | |
AssociatedAssets |
BIND
|
Utilities |
POST
PATCH
|
Graphs |
POST
PATCH
|
UMounting |
POST
PATCH
|
Verb(s) | Required Permission(s) | Link | Description |
---|
POST | WS-AddAuxiliaryMaterial | integration/api/odata/AuxiliaryMaterials | |
PATCH | WS-ModifyAuxiliaryMaterial | integration/api/odata/AuxiliaryMaterials({key}) | |
DELETE | WS-ModifyAuxiliaryMaterial | integration/api/odata/AuxiliaryMaterials({key}) | |
GET | WS-ReadAuxiliaryMaterial | integration/api/odata/AuxiliaryMaterials | |
GET | WS-ReadAuxiliaryMaterial | integration/api/odata/AuxiliaryMaterials({key}) | |
AuxiliaryMaterials Actions
|
Action | Required Permission(s) | Link | Description |
---|
Cancel | WS-ModifyAuxiliaryMaterial | integration/api/odata/AuxiliaryMaterials({key})/Cancel | |
Activate | WS-ModifyAuxiliaryMaterial | integration/api/odata/AuxiliaryMaterials({key})/Activate | Function that will move a material in Active status. |
Deactivate | WS-ModifyAuxiliaryMaterial | integration/api/odata/AuxiliaryMaterials({key})/Deactivate | Function that will move a material in Inactive status. |
UploadFile | WS-AddFile | integration/api/odata/AuxiliaryMaterials({key})/UploadFile(File={file}) | |
DeleteFile | WS-ModifyFile | integration/api/odata/AuxiliaryMaterials({key})/DeleteFile(FileName={filename}) | |
AuxiliaryMaterials Functions
|
Function | Required Permission(s) | Link | Description |
---|
DownloadFile | WS-ReadFile | integration/api/odata/AuxiliaryMaterials({key})/DownloadFile(FileName={filename}) | |
GetAuditLogData | WS-ReadAuditLog | integration/api/odata/AuxiliaryMaterials({key})/GetAuditLogData | Function used to export all audit information for a specific entity. Please use the following Content-Type:application/vnd.openxmlformats-officedocument.spreadsheetml.sheet for file download |
AuxiliaryMaterials Custom Routes
|
CustomRoute | Required Permission(s) | Supported Method(s) | Description |
---|
integration/api/odata/AuxiliaryMaterials/In(Ids={ids}) | |
GET
| |
integration/api/odata/AuxiliaryMaterials/NotIn(Ids={ids}) | |
GET
| |
integration/api/odata/AuxiliaryMaterials({key})/Files | |
DELETE
| |
AuxiliaryMaterials Nested Properties
No nested properties
Verb(s) | Required Permission(s) | Link | Description |
---|
POST | WS-AddServerMaterial | integration/api/odata/BladeServerMaterials | |
PATCH | WS-ModifyServerMaterial | integration/api/odata/BladeServerMaterials({key}) | |
DELETE | WS-ModifyServerMaterial | integration/api/odata/BladeServerMaterials({key}) | |
GET | WS-ReadServerMaterial | integration/api/odata/BladeServerMaterials | |
GET | WS-ReadServerMaterial | integration/api/odata/BladeServerMaterials({key}) | |
BladeServerMaterials Actions
|
Action | Required Permission(s) | Link | Description |
---|
Cancel | WS-ModifyServerMaterial | integration/api/odata/BladeServerMaterials({key})/Cancel | |
Activate | WS-ModifyServerMaterial | integration/api/odata/BladeServerMaterials({key})/Activate | Function that will move a material in Active status. |
Deactivate | WS-ModifyServerMaterial | integration/api/odata/BladeServerMaterials({key})/Deactivate | Function that will move a material in Inactive status. |
UploadFile | WS-AddFile | integration/api/odata/BladeServerMaterials({key})/UploadFile(File={file}) | |
DeleteFile | WS-ModifyFile | integration/api/odata/BladeServerMaterials({key})/DeleteFile(FileName={filename}) | |
BladeServerMaterials Functions
|
Function | Required Permission(s) | Link | Description |
---|
DownloadFile | WS-ReadFile | integration/api/odata/BladeServerMaterials({key})/DownloadFile(FileName={filename}) | |
GetAuditLogData | WS-ReadAuditLog | integration/api/odata/BladeServerMaterials({key})/GetAuditLogData | Function used to export all audit information for a specific entity. Please use the following Content-Type:application/vnd.openxmlformats-officedocument.spreadsheetml.sheet for file download |
BladeServerMaterials Custom Routes
|
CustomRoute | Required Permission(s) | Supported Method(s) | Description |
---|
integration/api/odata/BladeServerMaterials/In(Ids={ids}) | |
GET
| |
integration/api/odata/BladeServerMaterials/NotIn(Ids={ids}) | |
GET
| |
integration/api/odata/BladeServerMaterials({key})/Files | |
DELETE
| |
BladeServerMaterials Nested Properties
No nested properties
Verb(s) | Required Permission(s) | Link | Description |
---|
POST | WS-AddPDUMaterial | integration/api/odata/BoardPDUMaterials | |
PATCH | WS-ModifyPDUMaterial | integration/api/odata/BoardPDUMaterials({key}) | |
DELETE | WS-ModifyPDUMaterial | integration/api/odata/BoardPDUMaterials({key}) | |
GET | WS-ReadPDUMaterial | integration/api/odata/BoardPDUMaterials | |
GET | WS-ReadPDUMaterial | integration/api/odata/BoardPDUMaterials({key}) | |
BoardPDUMaterials Actions
|
Action | Required Permission(s) | Link | Description |
---|
Cancel | WS-ModifyPDUMaterial | integration/api/odata/BoardPDUMaterials({key})/Cancel | |
Activate | WS-ModifyPDUMaterial | integration/api/odata/BoardPDUMaterials({key})/Activate | Function that will move a material in Active status. |
Deactivate | WS-ModifyPDUMaterial | integration/api/odata/BoardPDUMaterials({key})/Deactivate | Function that will move a material in Inactive status. |
UploadFile | WS-AddFile | integration/api/odata/BoardPDUMaterials({key})/UploadFile(File={file}) | |
DeleteFile | WS-ModifyFile | integration/api/odata/BoardPDUMaterials({key})/DeleteFile(FileName={filename}) | |
BoardPDUMaterials Functions
|
Function | Required Permission(s) | Link | Description |
---|
DownloadFile | WS-ReadFile | integration/api/odata/BoardPDUMaterials({key})/DownloadFile(FileName={filename}) | |
GetAuditLogData | WS-ReadAuditLog | integration/api/odata/BoardPDUMaterials({key})/GetAuditLogData | Function used to export all audit information for a specific entity. Please use the following Content-Type:application/vnd.openxmlformats-officedocument.spreadsheetml.sheet for file download |
BoardPDUMaterials Custom Routes
|
CustomRoute | Required Permission(s) | Supported Method(s) | Description |
---|
integration/api/odata/BoardPDUMaterials/In(Ids={ids}) | |
GET
| |
integration/api/odata/BoardPDUMaterials/NotIn(Ids={ids}) | |
GET
| |
integration/api/odata/BoardPDUMaterials({key})/Files | |
DELETE
| |
BoardPDUMaterials Nested Properties
No nested properties
Verb(s) | Required Permission(s) | Link | Description |
---|
POST | WS-ModifyPDUPanel | integration/api/odata/BreakerPanels({key}) | |
POST | WS-AddPDUPanel | integration/api/odata/BreakerPanels | |
DELETE | WS-ModifyPDUPanel | integration/api/odata/BreakerPanels({key}) | |
PATCH | WS-ModifyPDUPanel | integration/api/odata/BreakerPanels({key}) | |
GET | WS-ReadPDUPanel | integration/api/odata/BreakerPanels | |
GET | WS-ReadPDUPanel | integration/api/odata/BreakerPanels({key}) | |
BreakerPanels Actions
No actions
BreakerPanels Functions
No functions
BreakerPanels Custom Routes
|
CustomRoute | Required Permission(s) | Supported Method(s) | Description |
---|
integration/api/odata/BreakerPanels/In(Ids={ids}) | |
GET
| |
integration/api/odata/BreakerPanels/NotIn(Ids={ids}) | |
GET
| |
BreakerPanels Nested Properties
|
NestedProperty | Supported Method(s) |
---|
Breakers |
POST
PATCH
|
Verb(s) | Required Permission(s) | Link | Description |
---|
DELETE | WS-ModifyPDUBreaker | integration/api/odata/Breakers({key}) | |
PATCH | WS-ModifyPDUBreaker | integration/api/odata/Breakers({key}) | |
GET | WS-ReadPDUBreaker | integration/api/odata/Breakers | |
GET | WS-ReadPDUBreaker | integration/api/odata/Breakers({key}) | |
Breakers Actions
No actions
Breakers Functions
No functions
Breakers Custom Routes
|
CustomRoute | Required Permission(s) | Supported Method(s) | Description |
---|
integration/api/odata/Breakers/In(Ids={ids}) | |
GET
| |
integration/api/odata/Breakers/NotIn(Ids={ids}) | |
GET
| |
integration/api/odata/Breakers | |
DELETE
| |
integration/api/odata/Breakers({key})/OutputConnectors | |
DELETE
| |
Breakers Nested Properties
No nested properties
Verb(s) | Required Permission(s) | Link | Description |
---|
POST | WS-AddPDUMaterial | integration/api/odata/BusBarPDUMaterials | |
PATCH | WS-ModifyPDUMaterial | integration/api/odata/BusBarPDUMaterials({key}) | |
DELETE | WS-ModifyPDUMaterial | integration/api/odata/BusBarPDUMaterials({key}) | |
GET | WS-ReadPDUMaterial | integration/api/odata/BusBarPDUMaterials | |
GET | WS-ReadPDUMaterial | integration/api/odata/BusBarPDUMaterials({key}) | |
BusBarPDUMaterials Actions
|
Action | Required Permission(s) | Link | Description |
---|
Cancel | WS-ModifyPDUMaterial | integration/api/odata/BusBarPDUMaterials({key})/Cancel | |
Activate | WS-ModifyPDUMaterial | integration/api/odata/BusBarPDUMaterials({key})/Activate | Function that will move a material in Active status. |
Deactivate | WS-ModifyPDUMaterial | integration/api/odata/BusBarPDUMaterials({key})/Deactivate | Function that will move a material in Inactive status. |
UploadFile | WS-AddFile | integration/api/odata/BusBarPDUMaterials({key})/UploadFile(File={file}) | |
DeleteFile | WS-ModifyFile | integration/api/odata/BusBarPDUMaterials({key})/DeleteFile(FileName={filename}) | |
BusBarPDUMaterials Functions
|
Function | Required Permission(s) | Link | Description |
---|
DownloadFile | WS-ReadFile | integration/api/odata/BusBarPDUMaterials({key})/DownloadFile(FileName={filename}) | |
GetAuditLogData | WS-ReadAuditLog | integration/api/odata/BusBarPDUMaterials({key})/GetAuditLogData | Function used to export all audit information for a specific entity. Please use the following Content-Type:application/vnd.openxmlformats-officedocument.spreadsheetml.sheet for file download |
BusBarPDUMaterials Custom Routes
|
CustomRoute | Required Permission(s) | Supported Method(s) | Description |
---|
integration/api/odata/BusBarPDUMaterials/In(Ids={ids}) | |
GET
| |
integration/api/odata/BusBarPDUMaterials/NotIn(Ids={ids}) | |
GET
| |
integration/api/odata/BusBarPDUMaterials({key})/Files | |
DELETE
| |
BusBarPDUMaterials Nested Properties
No nested properties
Verb(s) | Required Permission(s) | Link | Description |
---|
POST | WS-AddBusinessApplication | integration/api/odata/BusinessApplications | |
POST | WS-ModifyBusinessApplication | integration/api/odata/BusinessApplications({key}) | |
PATCH | WS-ModifyBusinessApplication | integration/api/odata/BusinessApplications({key}) | |
DELETE | WS-ModifyBusinessApplication | integration/api/odata/BusinessApplications({key}) | |
GET | WS-ReadBusinessApplication | integration/api/odata/BusinessApplications | |
GET | WS-ReadBusinessApplication | integration/api/odata/BusinessApplications({key}) | |
BusinessApplications Actions
|
Action | Required Permission(s) | Link | Description |
---|
Cancel | | integration/api/odata/BusinessApplications({key})/Cancel | |
BusinessApplications Functions
No functions
BusinessApplications Custom Routes
|
CustomRoute | Required Permission(s) | Supported Method(s) | Description |
---|
integration/api/odata/BusinessApplications | |
DELETE
| |
integration/api/odata/BusinessApplications | |
POST
| |
integration/api/odata/BusinessApplications({key})/Ownership | WS-ReadBusinessApplicationBusinessGroupMap |
GET
| |
integration/api/odata/BusinessApplications({key})/Ownership({relatedKey}) | WS-ReadBusinessApplicationBusinessGroupMap |
GET
| |
integration/api/odata/BusinessApplications({key})/Ownership | WS-AddBusinessApplicationBusinessGroupMap |
POST
| |
integration/api/odata/BusinessApplications({key})/Ownership({relatedKey}) | WS-ModifyBusinessApplicationBusinessGroupMap |
PATCH
| |
integration/api/odata/BusinessApplications({key})/Ownership({relatedKey}) | WS-ModifyBusinessApplicationBusinessGroupMap |
DELETE
| |
integration/api/odata/BusinessApplications({key})/Support | WS-ReadBusinessApplicationSupportGroupMap |
GET
| |
integration/api/odata/BusinessApplications({key})/Support({relatedKey}) | WS-ReadBusinessApplicationSupportGroupMap |
GET
| |
integration/api/odata/BusinessApplications({key})/Support | WS-AddBusinessApplicationSupportGroupMap |
POST
| |
integration/api/odata/BusinessApplications({key})/Support({relatedKey}) | WS-ModifyBusinessApplicationSupportGroupMap |
PATCH
| |
integration/api/odata/BusinessApplications({key})/Support({relatedKey}) | WS-ModifyBusinessApplicationSupportGroupMap |
DELETE
| |
integration/api/odata/BusinessApplications({key})/Hosts | WS-ReadServerHost |
GET
| |
integration/api/odata/BusinessApplications({key})/Hosts({relatedKey}) | WS-ReadServerHost |
GET
| |
integration/api/odata/BusinessApplications/In(Ids={ids}) | |
GET
| |
integration/api/odata/BusinessApplications/NotIn(Ids={ids}) | |
GET
| |
BusinessApplications Nested Properties
|
NestedProperty | Supported Method(s) |
---|
Ownership |
BIND
POST
PATCH
|
Support |
BIND
POST
PATCH
|
Hosts | |
Verb(s) | Required Permission(s) | Link | Description |
---|
POST | WS-AddBusinessGroup | integration/api/odata/BusinessGroups | |
DELETE | WS-ModifyBusinessGroup | integration/api/odata/BusinessGroups({key}) | |
PATCH | WS-ModifyBusinessGroup | integration/api/odata/BusinessGroups({key}) | |
POST | WS-ModifyBusinessGroup | integration/api/odata/BusinessGroups({key}) | |
GET | WS-ReadBusinessGroup | integration/api/odata/BusinessGroups | |
GET | WS-ReadBusinessGroup | integration/api/odata/BusinessGroups({key}) | |
BusinessGroups Actions
No actions
BusinessGroups Functions
|
Function | Required Permission(s) | Link | Description |
---|
ListBusinessGroupLinkedRecords | WS-ReadBusinessGroupAssetMap,WS-ReadServerHostBusinessGroupMap,WS-ReadBusinessApplicationBusinessGroupMap | integration/api/odata/BusinessGroups/ListBusinessGroupLinkedRecords(BusinessGroupID={businessgroupid}) | |
GetWorkingHours | WS-ReadBusinessGroup | integration/api/odata/BusinessGroups/GetWorkingHours(AssigneeID={assigneeid}) | |
GetNonWorkingDates | WS-ReadBusinessGroup | integration/api/odata/BusinessGroups/GetNonWorkingDates(AssigneeID={assigneeid}) | The function will return a collection of Nlyte.Model.ExclusionDate for business groups. |
GetBusinessGroupDescendants | WS-ReadBusinessGroup | integration/api/odata/BusinessGroups({key})/GetBusinessGroupDescendants(IncludeSelf={includeself}) | |
GetBusinessGroupAscendantsAndSelf | WS-ReadBusinessGroup | integration/api/odata/BusinessGroups({key})/GetBusinessGroupAscendantsAndSelf | |
BusinessGroups Custom Routes
|
CustomRoute | Required Permission(s) | Supported Method(s) | Description |
---|
integration/api/odata/BusinessGroups/In(Ids={ids}) | |
GET
| |
integration/api/odata/BusinessGroups/NotIn(Ids={ids}) | |
GET
| |
integration/api/odata/BusinessGroups | |
DELETE
| |
integration/api/odata/BusinessGroups | |
POST
| |
integration/api/odata/BusinessGroups({key})/AssociatedBusinessGroups | |
GET
| |
integration/api/odata/BusinessGroups({key})/AssociatedBusinessGroups({relatedKey}) | |
GET
| |
integration/api/odata/BusinessGroups({key})/AssociatedBusinessGroups | |
POST
| |
integration/api/odata/BusinessGroups({key})/AssociatedBusinessGroups({relatedKey}) | |
PATCH
| |
integration/api/odata/BusinessGroups({key})/AssociatedBusinessGroups({relatedKey}) | |
DELETE
| |
integration/api/odata/BusinessGroups({key})/BusinessGroupContacts | WS-ReadBusinessGroupResourceMap |
GET
| |
integration/api/odata/BusinessGroups({key})/BusinessGroupContacts({relatedKey}) | WS-ReadBusinessGroupResourceMap,WS-ReadResource |
GET
| |
integration/api/odata/BusinessGroups({key})/BusinessGroupContacts | WS-AddBusinessGroupResourceMap |
POST
| |
integration/api/odata/BusinessGroups({key})/BusinessGroupContacts({relatedKey}) | WS-ModifyBusinessGroupResourceMap |
PATCH
| |
integration/api/odata/BusinessGroups({key})/BusinessGroupContacts({relatedKey}) | WS-ModifyBusinessGroupResourceMap |
DELETE
| |
integration/api/odata/BusinessGroups({key})/Notes({relatedKey}) | |
GET
| |
integration/api/odata/BusinessGroups({key})/Notes | |
GET
| |
integration/api/odata/BusinessGroups({key})/Notes | |
POST
| |
integration/api/odata/BusinessGroups({key})/Notes | |
DELETE
| |
integration/api/odata/BusinessGroups({key})/Notes({relatedKey}) | |
DELETE
| |
integration/api/odata/BusinessGroups({key})/Notes({relatedKey}) | |
PATCH
| |
BusinessGroups Nested Properties
|
NestedProperty | Supported Method(s) |
---|
AssociatedBusinessGroups |
BIND
POST
PATCH
|
BusinessGroupContacts |
BIND
POST
PATCH
|
Verb(s) | Required Permission(s) | Link | Description |
---|
POST | WS-AddMarker | integration/api/odata/CabinetMarkers | |
DELETE | | integration/api/odata/CabinetMarkers({key}) | |
PATCH | WS-ModifyMarker | integration/api/odata/CabinetMarkers({key}) | |
GET | WS-ReadMarker | integration/api/odata/CabinetMarkers | |
GET | WS-ReadMarker | integration/api/odata/CabinetMarkers({key}) | |
CabinetMarkers Actions
No actions
CabinetMarkers Functions
No functions
CabinetMarkers Custom Routes
|
CustomRoute | Required Permission(s) | Supported Method(s) | Description |
---|
integration/api/odata/CabinetMarkers/In(Ids={ids}) | |
GET
| |
integration/api/odata/CabinetMarkers/NotIn(Ids={ids}) | |
GET
| |
CabinetMarkers Nested Properties
No nested properties
Verb(s) | Required Permission(s) | Link | Description |
---|
POST | WS-ModifyCabinetMaterial | integration/api/odata/CabinetMaterials({key}) | |
POST | WS-AddCabinetMaterial | integration/api/odata/CabinetMaterials | |
PATCH | WS-ModifyCabinetMaterial | integration/api/odata/CabinetMaterials({key}) | |
DELETE | WS-ModifyCabinetMaterial | integration/api/odata/CabinetMaterials({key}) | |
GET | WS-ReadCabinetMaterial | integration/api/odata/CabinetMaterials | |
GET | WS-ReadCabinetMaterial | integration/api/odata/CabinetMaterials({key}) | |
CabinetMaterials Actions
|
Action | Required Permission(s) | Link | Description |
---|
Cancel | WS-ModifyCabinetMaterial | integration/api/odata/CabinetMaterials({key})/Cancel | |
Activate | WS-ModifyCabinetMaterial | integration/api/odata/CabinetMaterials({key})/Activate | Function that will move a material in Active status. |
Deactivate | WS-ModifyCabinetMaterial | integration/api/odata/CabinetMaterials({key})/Deactivate | Function that will move a material in Inactive status. |
UploadFile | WS-AddFile | integration/api/odata/CabinetMaterials({key})/UploadFile(File={file}) | |
DeleteFile | WS-ModifyFile | integration/api/odata/CabinetMaterials({key})/DeleteFile(FileName={filename}) | |
CabinetMaterials Functions
|
Function | Required Permission(s) | Link | Description |
---|
DownloadFile | WS-ReadFile | integration/api/odata/CabinetMaterials({key})/DownloadFile(FileName={filename}) | |
GetAuditLogData | WS-ReadAuditLog | integration/api/odata/CabinetMaterials({key})/GetAuditLogData | Function used to export all audit information for a specific entity. Please use the following Content-Type:application/vnd.openxmlformats-officedocument.spreadsheetml.sheet for file download |
CabinetMaterials Custom Routes
|
CustomRoute | Required Permission(s) | Supported Method(s) | Description |
---|
integration/api/odata/CabinetMaterials/In(Ids={ids}) | |
GET
| |
integration/api/odata/CabinetMaterials/NotIn(Ids={ids}) | |
GET
| |
integration/api/odata/CabinetMaterials({key})/Files | |
DELETE
| |
CabinetMaterials Nested Properties
No nested properties
Verb(s) | Required Permission(s) | Link | Description |
---|
GET | WS-ReadCabinet | integration/api/odata/Cabinets | |
POST | WS-ModifyCabinet | integration/api/odata/Cabinets({key}) | |
PATCH | WS-ModifyCabinet | integration/api/odata/Cabinets({key}) | |
POST | WS-AddCabinet | integration/api/odata/Cabinets | |
DELETE | WS-ModifyCabinet | integration/api/odata/Cabinets({key}) | |
GET | WS-ReadCabinet | integration/api/odata/Cabinets({key}) | |
Cabinets Actions
|
Action | Required Permission(s) | Link | Description |
---|
BeginMove | WS-PlanRecycleCabinet, WS-PlanDecommissionCabinet | integration/api/odata/Cabinets({key})/BeginMove(RelocateType={relocatetype}) | Function that is used to move the selected asset in a planned state, Moving, Recycling or Decommissioning, depending on the RelocateType provided as parameter. The response contains the Planned AssetId. |
CancelMove | WS-CancelRecycleCabinet, WS-CancelDecommissionCabinet | integration/api/odata/Cabinets({key})/CancelMove | Function that is used to cancel planned action. The selected asset will become Active/Operational. |
CompleteMove | WS-CompleteRecycleCabinet, WS-CompleteDecommissionCabinet | integration/api/odata/Cabinets({key})/CompleteMove | Function that is used to finish planned action. The selected asset will become Active/Operational, Recycled/Available or Decommissioned/Decommissioned, depending on the Planned entity type (Move, Recycle or Deccommission). |
DirectMove | WS-SetLocationCabinet | integration/api/odata/Cabinets({key})/DirectMove(RelocateType={relocatetype}, LocationGroupID={locationgroupid}) | Function that is used to directly move an asset to a new location in a final state. |
CompleteCreation | WS-ModifyCabinet | integration/api/odata/Cabinets({key})/CompleteCreation | Function that moves an asset from Planned/(Pre)Procurement to Active/Operational. |
SetMaterial | | integration/api/odata/Cabinets({key})/SetMaterial(NewMaterialID={newmaterialid}) | Function that is used to change the material on an existing asset. This action is only supported for Receptacles and Power Strips. |
AddRealTimeValues | WS-AddAssetRealtimeData | integration/api/odata/Cabinets({key})/AddRealTimeValues(RealTimeInfo={realtimeinfo}, RealTimeValue={realtimevalue}) | Adds a provider specfic recorded real-time value against an asset or its associated outlet. Custom metrics are only allowed on assets whereas load, power and voltage metrics are allowed against assets, outlets or their relevant phases. |
AddNetworkAsset | WS-ReadNetworkConnection,WS-AddNetworkConnection | integration/api/odata/Cabinets({key})/AddNetworkAsset(NetworkAssetId={networkassetid}) | Function that is adding the selected asset in the list of available asset to be used in network connections. The mapping between the two assets is created by providing the NetworkAssetId parameter in the BODY, NetworkAssetId representing the AssetID of the asset to be added in the list of available assets. |
RemoveNetworkAsset | WS-ModifyNetworkConnection | integration/api/odata/Cabinets({key})/RemoveNetworkAsset(NetworkAssetId={networkassetid}, NetworkLinkerType={networklinkertype}) | Function that removes an asset from the association list of available asset to be used in network connections. |
UploadFile | WS-AddFile | integration/api/odata/Cabinets({key})/UploadFile(File={file}) | |
DeleteFile | WS-ModifyFile | integration/api/odata/Cabinets({key})/DeleteFile(FileName={filename}) | |
Cabinets Functions
|
Function | Required Permission(s) | Link | Description |
---|
ListLinkedRecords | | integration/api/odata/Cabinets/ListLinkedRecords(assetIds={assetids}) | |
GetAvailableUsForMaterial | | integration/api/odata/Cabinets({key})/GetAvailableUsForMaterial(MaterialID={materialid}) | |
GetByLocation | | integration/api/odata/Cabinets/GetByLocation(locationGroupID={locationgroupid}) | |
GetMountedPowerstrips | WS-ReadPowerStrip | integration/api/odata/Cabinets({key})/GetMountedPowerstrips | |
GetTotalSystemPowerConsumption | WS-ReadCabinet | integration/api/odata/Cabinets({key})/GetTotalSystemPowerConsumption | Function that returns the TotalSystemPowerConsumption for the selected asset. |
GetRealTimePowerInfo | WS-ReadCabinet | integration/api/odata/Cabinets({key})/GetRealTimePowerInfo | |
GetDiscoveryAssetPage | WS-ReadCabinet | integration/api/odata/Cabinets({key})/GetDiscoveryAssetPage | Function that returns a collection of entities of type Nlyte.Model.AssetMapping. Used to determine external providers. |
RecordModifiedInfo | WS-ReadCabinet | integration/api/odata/Cabinets({key})/RecordModifiedInfo | Function that returns an entity of type Nlyte.Model.AuditLogInfo and provides information regarding last modifications against the current asset |
GetCabinetAssetPanelSummary | | integration/api/odata/Cabinets/GetCabinetAssetPanelSummary(cabinetAssetIds={cabinetassetids}) | |
GetMountedChildAssets | | integration/api/odata/Cabinets({key})/GetMountedChildAssets(IncludeHosts={includehosts}, IncludeCards={includecards}) | Function that returns a collection of entities of type Nlyte.Model.MountedAssetSummary representing the list of mounted assets in the provided asset. The function is called as follows: Assets(AssetID)/GetMountedChildAssets(IncludeHosts=true,IncludeCards=true) where AssetID is the parent for which the children are retrieved. |
GetDistributorsWithFreeOutlets | WS-ReadAssetToAssetMapping | integration/api/odata/Cabinets({key})/GetDistributorsWithFreeOutlets(SearchTerm={searchterm}, SearchTermOption={searchtermoption}, LocationDepth={locationdepth}, MaterialTypeID={materialtypeid}, MaterialSubtypeID={materialsubtypeid}) | Function that returns a collection of entities of type Nlyte.Model.Distributor representing available power suppliers. |
SearchAssetNetworkPortLinkage | WS-ReadNetworkConnection | integration/api/odata/Cabinets({key})/SearchAssetNetworkPortLinkage(SearchTerm={searchterm}, SearchTermOption={searchtermoption}, CabinetMountingStatus={cabinetmountingstatus}, LocationTarget={locationtarget}, NetworkTypes={networktypes}, PortLocation={portlocation}) | Function that returns a collection of entities of type Nlyte.Model.AssetNetworkPortLinkage representing available assets to be used in network connections. |
GetRealTimeValues | WS-ReadAssetRealtimeData | integration/api/odata/Cabinets({key})/GetRealTimeValues | Function that returns a collection of entities of type Nlyte.Model.RealTimeValue. |
GetAssetSummaries | | integration/api/odata/Cabinets({key})/GetAssetSummaries(OwnedPeripherals={ownedperipherals}, IncludeHosts={includehosts}) | |
GetNetworkCardPortsInfo | WS-ReadNetworkConnection | integration/api/odata/Cabinets({key})/GetNetworkCardPortsInfo | Returns an object of type Nlyte.Model.NetworkResults having information about Copper and Fiber Ports |
GetNetworkCardPortConnections | WS-ReadNetworkConnection | integration/api/odata/Cabinets({key})/GetNetworkCardPortConnections | Returns an object of type Nlyte.Model.NetworkResults having information about Copper and Fiber Port connections |
GetNetworkAssetSummary | WS-ReadNetworkConnection | integration/api/odata/Cabinets({key})/GetNetworkAssetSummary | Returns an object of type Nlyte.Model.NetworkResults having information about the networkable assets. |
ListPowerConsumers | | integration/api/odata/Cabinets({key})/ListPowerConsumers | Function that returns a collection of Nlyte.Model.Graph entities. Used to identify available Output Connector used in power connections. |
SupportsPlannedMove | | integration/api/odata/Cabinets({key})/SupportsPlannedMove | |
GetTotalSystemWeight | | integration/api/odata/Cabinets({key})/GetTotalSystemWeight | Function that returns the TotalSystemWeight for the selected asset. |
GetAssetsReportData | WS-ReadNetwork,WS-ReadCabinet,WS-ReadPeripheral,WS-ReadKVMSwitch,WS-ReadServer,WS-ReadPDU,WS-ReadPowerStrip,WS-ReadAirConditioning,WS-ReadReceptacle,WS-ReadChassis,WS-ReadUPS,WS-ReadAuxiliary,WS-ReadStaticSwitch,WS-ReadServerHost | integration/api/odata/Cabinets/GetAssetsReportData(assetIds={assetids}) | |
GetConventionSets | | integration/api/odata/Cabinets/GetConventionSets(EntityTypeID={entitytypeid}) | |
GetConventions | | integration/api/odata/Cabinets/GetConventions(ConventionSetID={conventionsetid}) | |
GenerateConventionName | | integration/api/odata/Cabinets/GenerateConventionName(ConventionID={conventionid}) | |
DownloadFile | WS-ReadFile | integration/api/odata/Cabinets({key})/DownloadFile(FileName={filename}) | |
GetConventionSets | | integration/api/odata/Cabinets/GetConventionSets(EntityTypeID={entitytypeid}) | |
GetConventions | | integration/api/odata/Cabinets/GetConventions(ConventionSetID={conventionsetid}) | |
GenerateConventionName | | integration/api/odata/Cabinets/GenerateConventionName(ConventionID={conventionid}) | |
GetAuditLogData | WS-ReadAuditLog | integration/api/odata/Cabinets({key})/GetAuditLogData | Function used to export all audit information for a specific entity. Please use the following Content-Type:application/vnd.openxmlformats-officedocument.spreadsheetml.sheet for file download |
Cabinets Custom Routes
|
CustomRoute | Required Permission(s) | Supported Method(s) | Description |
---|
integration/api/odata/Cabinets({key})/ProviderCabinets({relatedKey}) | |
DELETE
| |
integration/api/odata/Cabinets({key})/ConsumerCabinets({relatedKey}) | |
DELETE
| |
integration/api/odata/Cabinets | |
GET
| |
integration/api/odata/Cabinets({key})/Subnets | |
POST
| |
integration/api/odata/Cabinets({key})/Subnets({relatedKey}) | |
PATCH
| |
integration/api/odata/Cabinets({key})/Subnets({relatedKey}) | |
DELETE
| |
integration/api/odata/Cabinets({key})/Graphs | |
GET
| |
integration/api/odata/Cabinets({key})/Graphs({relatedKey}) | |
GET
| |
integration/api/odata/Cabinets({key})/Graphs({relatedKey}) | |
PATCH
| |
integration/api/odata/Cabinets({key})/Graphs | |
POST
| |
integration/api/odata/Cabinets({key})/Graphs({relatedKey}) | |
DELETE
| |
integration/api/odata/Cabinets({key})/Notes({relatedKey}) | |
GET
| |
integration/api/odata/Cabinets({key})/Notes | |
GET
| |
integration/api/odata/Cabinets({key})/Notes | |
POST
| |
integration/api/odata/Cabinets({key})/Notes | |
DELETE
| |
integration/api/odata/Cabinets({key})/Notes({relatedKey}) | |
DELETE
| |
integration/api/odata/Cabinets({key})/Notes({relatedKey}) | |
PATCH
| |
integration/api/odata/Cabinets({key})/KVMSwitches({relatedKey}) | WS-ModifyKVMSwitchCabinetMap |
DELETE
| |
integration/api/odata/Cabinets({key})/KVMSwitches | WS-AddKVMSwitchCabinetMap |
POST
| |
integration/api/odata/Cabinets({key})/GetServiceRequests | |
GET
| |
integration/api/odata/Cabinets({key})/CustomFields | WS-ReadCustomFieldCabinet |
GET
| |
integration/api/odata/Cabinets({key})/CustomFields | WS-ModifyCustomFieldCabinet |
POST
| |
integration/api/odata/Cabinets({key})/CustomFields({relatedKey}) | WS-ModifyCustomFieldCabinet |
PATCH
| |
integration/api/odata/Cabinets({key})/CustomFields({relatedKey}) | WS-ModifyCustomFieldCabinet |
DELETE
| |
integration/api/odata/Cabinets({key})/Warranty | WS-ReadCabinet |
GET
| |
integration/api/odata/Cabinets({key})/Warranty | WS-ModifyCabinet |
POST
| |
integration/api/odata/Cabinets({key})/Warranty | WS-ModifyCabinet |
PATCH
| |
integration/api/odata/Cabinets({key})/Warranty | WS-ModifyCabinet |
DELETE
| |
integration/api/odata/Cabinets({key})/Maintenance | WS-ReadCabinet |
GET
| |
integration/api/odata/Cabinets({key})/Maintenance | WS-ModifyCabinet |
POST
| |
integration/api/odata/Cabinets({key})/Maintenance | WS-ModifyCabinet |
PATCH
| |
integration/api/odata/Cabinets({key})/Maintenance | WS-ModifyCabinet |
DELETE
| |
integration/api/odata/Cabinets({key})/AssetMounting | |
GET
| |
integration/api/odata/Cabinets({key})/Ownership | WS-ReadBusinessGroupAssetMap |
GET
| |
integration/api/odata/Cabinets({key})/Ownership({relatedKey}) | WS-ReadBusinessGroupAssetMap |
GET
| |
integration/api/odata/Cabinets({key})/Ownership | WS-AddBusinessGroupAssetMap |
POST
| |
integration/api/odata/Cabinets({key})/Ownership({relatedKey}) | WS-ModifyBusinessGroupAssetMap |
PATCH
| |
integration/api/odata/Cabinets({key})/Ownership({relatedKey}) | WS-ModifyBusinessGroupAssetMap |
DELETE
| |
integration/api/odata/Cabinets({key})/Support | WS-ReadSupportGroupAssetMap |
GET
| |
integration/api/odata/Cabinets({key})/Support({relatedKey}) | WS-ReadSupportGroupAssetMap |
GET
| |
integration/api/odata/Cabinets({key})/Support | WS-AddSupportGroupAssetMap |
POST
| |
integration/api/odata/Cabinets({key})/Support({relatedKey}) | WS-ModifySupportGroupAssetMap |
PATCH
| |
integration/api/odata/Cabinets({key})/Support({relatedKey}) | WS-ModifySupportGroupAssetMap |
DELETE
| |
integration/api/odata/Cabinets({key})/Shelves({relatedKey}) | WS-ModifyShelf |
DELETE
| |
integration/api/odata/Cabinets({key})/Markers({relatedKey}) | WS-ModifyMarker |
DELETE
| |
integration/api/odata/Cabinets({key})/AssociatedAssets({relatedKey}) | |
DELETE
| |
integration/api/odata/Cabinets({key})/AssociatedAssets({relatedKey})/Notes({nestedRelatedKey}) | |
GET
| |
integration/api/odata/Cabinets({key})/AssociatedAssets({relatedKey})/Notes | |
GET
| |
integration/api/odata/Cabinets({key})/AssociatedAssets({relatedKey})/Notes({nestedRelatedKey}) | |
PATCH
| |
integration/api/odata/Cabinets({key})/AssociatedAssets({relatedKey})/Notes | |
POST
| |
integration/api/odata/Cabinets({key})/AssociatedAssets({relatedKey})/Notes | |
DELETE
| |
integration/api/odata/Cabinets({key})/AssociatedAssets({relatedKey})/Notes({nestedRelatedKey}) | |
DELETE
| |
integration/api/odata/Cabinets/In(Ids={ids}) | |
GET
| |
integration/api/odata/Cabinets/NotIn(Ids={ids}) | |
GET
| |
integration/api/odata/Cabinets({key})/Files | |
DELETE
| |
Cabinets Nested Properties
|
NestedProperty | Supported Method(s) |
---|
Ownership |
BIND
POST
PATCH
|
Support |
BIND
POST
PATCH
|
CustomFields |
POST
PATCH
|
Maintenance |
POST
PATCH
|
Warranty |
POST
PATCH
|
AssetIPAddressMap |
POST
PATCH
|
LocationGroup | |
AssociatedAssets |
BIND
|
KVMSwitches |
POST
|
InputConnectors |
PATCH
|
Subnets |
BIND
POST
PATCH
|
CabinetAssets |
BIND
POST
PATCH
|
Graphs |
POST
PATCH
|
UMounting | |
Shelves |
POST
PATCH
|
Markers |
POST
PATCH
|
ProviderCabinets |
POST
PATCH
|
ConsumerCabinets |
POST
PATCH
|
Verb(s) | Required Permission(s) | Link | Description |
---|
POST | WS-AddNetworkMaterial | integration/api/odata/CardNetworkMaterials | |
PATCH | WS-ModifyNetworkMaterial | integration/api/odata/CardNetworkMaterials({key}) | |
DELETE | WS-ModifyNetworkMaterial | integration/api/odata/CardNetworkMaterials({key}) | |
GET | WS-ReadNetworkMaterial | integration/api/odata/CardNetworkMaterials | |
GET | WS-ReadNetworkMaterial | integration/api/odata/CardNetworkMaterials({key}) | |
CardNetworkMaterials Actions
|
Action | Required Permission(s) | Link | Description |
---|
Cancel | WS-ModifyNetworkMaterial | integration/api/odata/CardNetworkMaterials({key})/Cancel | |
Activate | WS-ModifyNetworkMaterial | integration/api/odata/CardNetworkMaterials({key})/Activate | Function that will move a material in Active status. |
Deactivate | WS-ModifyNetworkMaterial | integration/api/odata/CardNetworkMaterials({key})/Deactivate | Function that will move a material in Inactive status. |
UploadFile | WS-AddFile | integration/api/odata/CardNetworkMaterials({key})/UploadFile(File={file}) | |
DeleteFile | WS-ModifyFile | integration/api/odata/CardNetworkMaterials({key})/DeleteFile(FileName={filename}) | |
CardNetworkMaterials Functions
|
Function | Required Permission(s) | Link | Description |
---|
DownloadFile | WS-ReadFile | integration/api/odata/CardNetworkMaterials({key})/DownloadFile(FileName={filename}) | |
GetAuditLogData | WS-ReadAuditLog | integration/api/odata/CardNetworkMaterials({key})/GetAuditLogData | Function used to export all audit information for a specific entity. Please use the following Content-Type:application/vnd.openxmlformats-officedocument.spreadsheetml.sheet for file download |
CardNetworkMaterials Custom Routes
|
CustomRoute | Required Permission(s) | Supported Method(s) | Description |
---|
integration/api/odata/CardNetworkMaterials/In(Ids={ids}) | |
GET
| |
integration/api/odata/CardNetworkMaterials/NotIn(Ids={ids}) | |
GET
| |
integration/api/odata/CardNetworkMaterials({key})/Files | |
DELETE
| |
CardNetworkMaterials Nested Properties
No nested properties
Verb(s) | Required Permission(s) | Link | Description |
---|
GET | | integration/api/odata/CatalogTypes | |
GET | | integration/api/odata/CatalogTypes({key}) | |
CatalogTypes Actions
No actions
CatalogTypes Functions
No functions
CatalogTypes Custom Routes
|
CustomRoute | Required Permission(s) | Supported Method(s) | Description |
---|
integration/api/odata/CatalogTypes/In(Ids={ids}) | |
GET
| |
integration/api/odata/CatalogTypes/NotIn(Ids={ids}) | |
GET
| |
CatalogTypes Nested Properties
No nested properties
Verb(s) | Required Permission(s) | Link | Description |
---|
GET | WS-ReadFloorPlan | integration/api/odata/CeilingMaterials | |
GET | WS-ReadFloorPlan | integration/api/odata/CeilingMaterials({key}) | |
CeilingMaterials Actions
No actions
CeilingMaterials Functions
No functions
CeilingMaterials Custom Routes
|
CustomRoute | Required Permission(s) | Supported Method(s) | Description |
---|
integration/api/odata/CeilingMaterials/In(Ids={ids}) | |
GET
| |
integration/api/odata/CeilingMaterials/NotIn(Ids={ids}) | |
GET
| |
CeilingMaterials Nested Properties
No nested properties
Verb(s) | Required Permission(s) | Link | Description |
---|
PATCH | WS-ModifyChassis | integration/api/odata/Chassis({key}) | |
POST | WS-AddChassis | integration/api/odata/Chassis | |
DELETE | WS-ModifyChassis | integration/api/odata/Chassis({key}) | |
POST | WS-ModifyChassis | integration/api/odata/Chassis({key}) | |
GET | WS-ReadChassis | integration/api/odata/Chassis | |
GET | WS-ReadChassis | integration/api/odata/Chassis({key}) | |
Chassis Actions
|
Action | Required Permission(s) | Link | Description |
---|
BeginMove | WS-PlanMoveChassis, WS-PlanRecycleChassis, WS-PlanDecommissionChassis | integration/api/odata/Chassis({key})/BeginMove(RelocateType={relocatetype}) | Function that is used to move the selected asset in a planned state, Moving, Recycling or Decommissioning, depending on the RelocateType provided as parameter. The response contains the Planned AssetId. |
CancelMove | WS-CancelMoveChassis, WS-CancelRecycleChassis, WS-CancelDecommissionChassis | integration/api/odata/Chassis({key})/CancelMove | Function that is used to cancel planned action. The selected asset will become Active/Operational. |
CompleteMove | WS-CompleteMoveChassis, WS-CompleteRecycleChassis, WS-CompleteDecommissionChassis | integration/api/odata/Chassis({key})/CompleteMove | Function that is used to finish planned action. The selected asset will become Active/Operational, Recycled/Available or Decommissioned/Decommissioned, depending on the Planned entity type (Move, Recycle or Deccommission). |
DirectMove | WS-SetLocationChassis | integration/api/odata/Chassis({key})/DirectMove(RelocateType={relocatetype}, LocationGroupID={locationgroupid}) | Function that is used to directly move an asset to a new location in a final state. |
CompleteCreation | WS-ModifyChassis | integration/api/odata/Chassis({key})/CompleteCreation | Function that moves an asset from Planned/(Pre)Procurement to Active/Operational. |
SetMaterial | | integration/api/odata/Chassis({key})/SetMaterial(NewMaterialID={newmaterialid}) | Function that is used to change the material on an existing asset. This action is only supported for Receptacles and Power Strips. |
AddRealTimeValues | WS-AddAssetRealtimeData | integration/api/odata/Chassis({key})/AddRealTimeValues(RealTimeInfo={realtimeinfo}, RealTimeValue={realtimevalue}) | Adds a provider specfic recorded real-time value against an asset or its associated outlet. Custom metrics are only allowed on assets whereas load, power and voltage metrics are allowed against assets, outlets or their relevant phases. |
AddNetworkAsset | WS-ReadNetworkConnection,WS-AddNetworkConnection | integration/api/odata/Chassis({key})/AddNetworkAsset(NetworkAssetId={networkassetid}) | Function that is adding the selected asset in the list of available asset to be used in network connections. The mapping between the two assets is created by providing the NetworkAssetId parameter in the BODY, NetworkAssetId representing the AssetID of the asset to be added in the list of available assets. |
RemoveNetworkAsset | WS-ModifyNetworkConnection | integration/api/odata/Chassis({key})/RemoveNetworkAsset(NetworkAssetId={networkassetid}, NetworkLinkerType={networklinkertype}) | Function that removes an asset from the association list of available asset to be used in network connections. |
UploadFile | WS-AddFile | integration/api/odata/Chassis({key})/UploadFile(File={file}) | |
DeleteFile | WS-ModifyFile | integration/api/odata/Chassis({key})/DeleteFile(FileName={filename}) | |
Chassis Functions
|
Function | Required Permission(s) | Link | Description |
---|
ListLinkedRecords | | integration/api/odata/Chassis/ListLinkedRecords(assetIds={assetids}) | Retrieves a collection of assets, associated to the selected chassis that will be affected by a potential move action. |
GetBladesInLocation | WS-ReadCabinet,WS-ReadServer,WS-ReadChassis,WS-ReadServerMaterial | integration/api/odata/Chassis({key})/GetBladesInLocation(SearchTerm={searchterm}, SearchTermOption={searchtermoption}, LocationGroupID={locationgroupid}, OrientationID={orientationid}) | |
GetStandardServersInLocation | WS-ReadCabinet,WS-ReadServer,WS-ReadChassis,WS-ReadServerMaterial | integration/api/odata/Chassis({key})/GetStandardServersInLocation(SearchTerm={searchterm}, SearchTermOption={searchtermoption}, LocationGroupID={locationgroupid}, OrientationID={orientationid}) | |
GetModulesInLocation | WS-ReadCabinet,WS-ReadNetwork,WS-ReadChassis,WS-ReadNetworkMaterial | integration/api/odata/Chassis({key})/GetModulesInLocation(SearchTerm={searchterm}, SearchTermOption={searchtermoption}, LocationGroupID={locationgroupid}, OrientationID={orientationid}) | |
GetTotalSystemPowerConsumption | WS-ReadChassis | integration/api/odata/Chassis({key})/GetTotalSystemPowerConsumption | Function that returns the TotalSystemPowerConsumption for the selected asset. |
GetAssetAllocationCriteria | WS-ReadChassis | integration/api/odata/Chassis({key})/GetAssetAllocationCriteria | Used to retrieve Nlyte.Model.AssetAllocationCriteria representing the available allocation criteria used in auto-allocation. |
GetRealTimePowerInfo | WS-ReadChassis | integration/api/odata/Chassis({key})/GetRealTimePowerInfo | |
GetDiscoveryAssetPage | WS-ReadChassis | integration/api/odata/Chassis({key})/GetDiscoveryAssetPage | Function that returns a collection of entities of type Nlyte.Model.AssetMapping. Used to determine external providers. |
RecordModifiedInfo | WS-ReadChassis | integration/api/odata/Chassis({key})/RecordModifiedInfo | Function that returns an entity of type Nlyte.Model.AuditLogInfo and provides information regarding last modifications against the current asset |
GetMountedChildAssets | | integration/api/odata/Chassis({key})/GetMountedChildAssets(IncludeHosts={includehosts}, IncludeCards={includecards}) | Function that returns a collection of entities of type Nlyte.Model.MountedAssetSummary representing the list of mounted assets in the provided asset. The function is called as follows: Assets(AssetID)/GetMountedChildAssets(IncludeHosts=true,IncludeCards=true) where AssetID is the parent for which the children are retrieved. |
GetDistributorsWithFreeOutlets | WS-ReadAssetToAssetMapping | integration/api/odata/Chassis({key})/GetDistributorsWithFreeOutlets(SearchTerm={searchterm}, SearchTermOption={searchtermoption}, LocationDepth={locationdepth}, MaterialTypeID={materialtypeid}, MaterialSubtypeID={materialsubtypeid}) | Function that returns a collection of entities of type Nlyte.Model.Distributor representing available power suppliers. |
SearchAssetNetworkPortLinkage | WS-ReadNetworkConnection | integration/api/odata/Chassis({key})/SearchAssetNetworkPortLinkage(SearchTerm={searchterm}, SearchTermOption={searchtermoption}, CabinetMountingStatus={cabinetmountingstatus}, LocationTarget={locationtarget}, NetworkTypes={networktypes}, PortLocation={portlocation}) | Function that returns a collection of entities of type Nlyte.Model.AssetNetworkPortLinkage representing available assets to be used in network connections. |
GetRealTimeValues | WS-ReadAssetRealtimeData | integration/api/odata/Chassis({key})/GetRealTimeValues | Function that returns a collection of entities of type Nlyte.Model.RealTimeValue. |
GetAssetSummaries | | integration/api/odata/Chassis({key})/GetAssetSummaries(OwnedPeripherals={ownedperipherals}, IncludeHosts={includehosts}) | |
GetNetworkCardPortsInfo | WS-ReadNetworkConnection | integration/api/odata/Chassis({key})/GetNetworkCardPortsInfo | Returns an object of type Nlyte.Model.NetworkResults having information about Copper and Fiber Ports |
GetNetworkCardPortConnections | WS-ReadNetworkConnection | integration/api/odata/Chassis({key})/GetNetworkCardPortConnections | Returns an object of type Nlyte.Model.NetworkResults having information about Copper and Fiber Port connections |
GetNetworkAssetSummary | WS-ReadNetworkConnection | integration/api/odata/Chassis({key})/GetNetworkAssetSummary | Returns an object of type Nlyte.Model.NetworkResults having information about the networkable assets. |
ListPowerConsumers | | integration/api/odata/Chassis({key})/ListPowerConsumers | Function that returns a collection of Nlyte.Model.Graph entities. Used to identify available Output Connector used in power connections. |
SupportsPlannedMove | | integration/api/odata/Chassis({key})/SupportsPlannedMove | |
GetTotalSystemWeight | | integration/api/odata/Chassis({key})/GetTotalSystemWeight | Function that returns the TotalSystemWeight for the selected asset. |
GetMountedOnAssetID | | integration/api/odata/Chassis({key})/GetMountedOnAssetID | |
GetAssetsReportData | WS-ReadNetwork,WS-ReadCabinet,WS-ReadPeripheral,WS-ReadKVMSwitch,WS-ReadServer,WS-ReadPDU,WS-ReadPowerStrip,WS-ReadAirConditioning,WS-ReadReceptacle,WS-ReadChassis,WS-ReadUPS,WS-ReadAuxiliary,WS-ReadStaticSwitch,WS-ReadServerHost | integration/api/odata/Chassis/GetAssetsReportData(assetIds={assetids}) | |
GetConventionSets | | integration/api/odata/Chassis/GetConventionSets(EntityTypeID={entitytypeid}) | |
GetConventions | | integration/api/odata/Chassis/GetConventions(ConventionSetID={conventionsetid}) | |
GenerateConventionName | | integration/api/odata/Chassis/GenerateConventionName(ConventionID={conventionid}) | |
DownloadFile | WS-ReadFile | integration/api/odata/Chassis({key})/DownloadFile(FileName={filename}) | |
GetConventionSets | | integration/api/odata/Chassis/GetConventionSets(EntityTypeID={entitytypeid}) | |
GetConventions | | integration/api/odata/Chassis/GetConventions(ConventionSetID={conventionsetid}) | |
GenerateConventionName | | integration/api/odata/Chassis/GenerateConventionName(ConventionID={conventionid}) | |
GetAuditLogData | WS-ReadAuditLog | integration/api/odata/Chassis({key})/GetAuditLogData | Function used to export all audit information for a specific entity. Please use the following Content-Type:application/vnd.openxmlformats-officedocument.spreadsheetml.sheet for file download |
Chassis Custom Routes
|
CustomRoute | Required Permission(s) | Supported Method(s) | Description |
---|
integration/api/odata/Chassis({key})/ChassisSlots | |
GET
| |
integration/api/odata/Chassis({key})/ChassisSlots({relatedKey}) | |
GET
| |
integration/api/odata/Chassis({key})/ChassisSlots | |
POST
| |
integration/api/odata/Chassis({key})/ChassisSlots({relatedKey}) | |
PATCH
| |
integration/api/odata/Chassis({key})/Wires | |
GET
| |
integration/api/odata/Chassis({key})/InternalEquipmentItems | |
POST
| |
integration/api/odata/Chassis({key})/InternalEquipmentItems({relatedKey}) | |
PATCH
| |
integration/api/odata/Chassis({key})/InternalEquipmentItems({relatedKey}) | |
DELETE
| |
integration/api/odata/Chassis({key})/Notes({relatedKey}) | |
GET
| |
integration/api/odata/Chassis({key})/Notes | |
GET
| |
integration/api/odata/Chassis({key})/Notes | |
POST
| |
integration/api/odata/Chassis({key})/Notes | |
DELETE
| |
integration/api/odata/Chassis({key})/Notes({relatedKey}) | |
DELETE
| |
integration/api/odata/Chassis({key})/Notes({relatedKey}) | |
PATCH
| |
integration/api/odata/Chassis({key})/Peripherals({relatedKey})/Notes({nestedRelatedKey}) | |
GET
| |
integration/api/odata/Chassis({key})/Peripherals({relatedKey})/Notes | |
GET
| |
integration/api/odata/Chassis({key})/Peripherals({relatedKey})/Notes({nestedRelatedKey}) | |
PATCH
| |
integration/api/odata/Chassis({key})/Peripherals({relatedKey})/Notes | |
POST
| |
integration/api/odata/Chassis({key})/Peripherals({relatedKey})/Notes | |
DELETE
| |
integration/api/odata/Chassis({key})/Peripherals({relatedKey})/Notes({nestedRelatedKey}) | |
DELETE
| |
integration/api/odata/Chassis({key})/AssociatedAssets({relatedKey}) | |
DELETE
| |
integration/api/odata/Chassis({key})/AssociatedAssets({relatedKey})/Notes({nestedRelatedKey}) | |
GET
| |
integration/api/odata/Chassis({key})/AssociatedAssets({relatedKey})/Notes | |
GET
| |
integration/api/odata/Chassis({key})/AssociatedAssets({relatedKey})/Notes({nestedRelatedKey}) | |
PATCH
| |
integration/api/odata/Chassis({key})/AssociatedAssets({relatedKey})/Notes | |
POST
| |
integration/api/odata/Chassis({key})/AssociatedAssets({relatedKey})/Notes | |
DELETE
| |
integration/api/odata/Chassis({key})/AssociatedAssets({relatedKey})/Notes({nestedRelatedKey}) | |
DELETE
| |
integration/api/odata/Chassis({key})/Graphs | |
GET
| |
integration/api/odata/Chassis({key})/Graphs({relatedKey}) | |
GET
| |
integration/api/odata/Chassis({key})/Graphs({relatedKey}) | |
PATCH
| |
integration/api/odata/Chassis({key})/Graphs | |
POST
| |
integration/api/odata/Chassis({key})/Graphs({relatedKey}) | |
DELETE
| |
integration/api/odata/Chassis({key})/GetAvailableCabinetUs(CabinetID={cabinetId}) | WS-ReadCabinet |
GET
| |
integration/api/odata/Chassis({key})/GetAvailableChassisSlots(OrientationID={orientationID}) | |
GET
| |
integration/api/odata/Chassis({key})/GetAvailableChassisSlotsForMaterial(OrientationID={orientationID}, MaterialID={materialID}) | |
GET
| |
integration/api/odata/Chassis({key})/GetAvailableChassisSlotsForAsset(OrientationID={orientationID}, AssetID={assetID}) | |
GET
| |
integration/api/odata/Chassis({key})/PhysicalPartitions | |
POST
| |
integration/api/odata/Chassis({key})/PhysicalPartitions | |
PATCH
| |
integration/api/odata/Chassis({key})/PhysicalPartitions({relatedKey}) | |
DELETE
| |
integration/api/odata/Chassis({key})/Peripherals | |
POST
| |
integration/api/odata/Chassis({key})/Peripherals({relatedKey}) | |
DELETE
| |
integration/api/odata/Chassis({key})/GetServiceRequests | |
GET
| |
integration/api/odata/Chassis({key})/CustomFields | WS-ReadCustomFieldChassis |
GET
| |
integration/api/odata/Chassis({key})/CustomFields | WS-ModifyCustomFieldChassis |
POST
| |
integration/api/odata/Chassis({key})/CustomFields({relatedKey}) | WS-ModifyCustomFieldChassis |
PATCH
| |
integration/api/odata/Chassis({key})/CustomFields({relatedKey}) | WS-ModifyCustomFieldChassis |
DELETE
| |
integration/api/odata/Chassis({key})/Warranty | WS-ReadChassis |
GET
| |
integration/api/odata/Chassis({key})/Warranty | WS-ModifyChassis |
POST
| |
integration/api/odata/Chassis({key})/Warranty | WS-ModifyChassis |
PATCH
| |
integration/api/odata/Chassis({key})/Warranty | WS-ModifyChassis |
DELETE
| |
integration/api/odata/Chassis({key})/Maintenance | WS-ReadChassis |
GET
| |
integration/api/odata/Chassis({key})/Maintenance | WS-ModifyChassis |
POST
| |
integration/api/odata/Chassis({key})/Maintenance | WS-ModifyChassis |
PATCH
| |
integration/api/odata/Chassis({key})/Maintenance | WS-ModifyChassis |
DELETE
| |
integration/api/odata/Chassis({key})/AssetMounting | |
GET
| |
integration/api/odata/Chassis({key})/Ownership | WS-ReadBusinessGroupAssetMap |
GET
| |
integration/api/odata/Chassis({key})/Ownership({relatedKey}) | WS-ReadBusinessGroupAssetMap |
GET
| |
integration/api/odata/Chassis({key})/Ownership | WS-AddBusinessGroupAssetMap |
POST
| |
integration/api/odata/Chassis({key})/Ownership({relatedKey}) | WS-ModifyBusinessGroupAssetMap |
PATCH
| |
integration/api/odata/Chassis({key})/Ownership({relatedKey}) | WS-ModifyBusinessGroupAssetMap |
DELETE
| |
integration/api/odata/Chassis({key})/Support | WS-ReadSupportGroupAssetMap |
GET
| |
integration/api/odata/Chassis({key})/Support({relatedKey}) | WS-ReadSupportGroupAssetMap |
GET
| |
integration/api/odata/Chassis({key})/Support | WS-AddSupportGroupAssetMap |
POST
| |
integration/api/odata/Chassis({key})/Support({relatedKey}) | WS-ModifySupportGroupAssetMap |
PATCH
| |
integration/api/odata/Chassis({key})/Support({relatedKey}) | WS-ModifySupportGroupAssetMap |
DELETE
| |
integration/api/odata/Chassis/In(Ids={ids}) | |
GET
| |
integration/api/odata/Chassis/NotIn(Ids={ids}) | |
GET
| |
integration/api/odata/Chassis({key})/Files | |
DELETE
| |
integration/api/odata/BulkUpdateChassisSlotNames | WS-ModifyChassis |
POST
| |
Chassis Nested Properties
|
NestedProperty | Supported Method(s) |
---|
Ownership |
BIND
POST
PATCH
|
Support |
BIND
POST
PATCH
|
CustomFields |
POST
PATCH
|
Maintenance |
POST
PATCH
|
Warranty |
POST
PATCH
|
AssetIPAddressMap |
POST
PATCH
|
LocationGroup | |
AssociatedAssets |
BIND
|
ServerHosts |
POST
PATCH
|
PhysicalPartitions |
POST
PATCH
|
InternalEquipmentItems |
POST
PATCH
|
Peripherals |
BIND
POST
PATCH
|
ChassisMountedAssetMaps |
POST
PATCH
|
ChassisSlots |
POST
PATCH
|
Graphs |
POST
PATCH
|
UMounting |
POST
PATCH
|
Verb(s) | Required Permission(s) | Link | Description |
---|
POST | WS-ModifyChassisMaterial | integration/api/odata/ChassisMaterials({key}) | |
POST | WS-AddChassisMaterial | integration/api/odata/ChassisMaterials | |
PATCH | WS-ModifyChassisMaterial | integration/api/odata/ChassisMaterials({key}) | |
DELETE | WS-ModifyChassisMaterial | integration/api/odata/ChassisMaterials({key}) | |
GET | WS-ReadChassisMaterial | integration/api/odata/ChassisMaterials | |
GET | WS-ReadChassisMaterial | integration/api/odata/ChassisMaterials({key}) | |
ChassisMaterials Actions
|
Action | Required Permission(s) | Link | Description |
---|
Cancel | WS-ModifyChassisMaterial | integration/api/odata/ChassisMaterials({key})/Cancel | |
Activate | WS-ModifyChassisMaterial | integration/api/odata/ChassisMaterials({key})/Activate | Function that will move a material in Active status. |
Deactivate | WS-ModifyChassisMaterial | integration/api/odata/ChassisMaterials({key})/Deactivate | Function that will move a material in Inactive status. |
UploadFile | WS-AddFile | integration/api/odata/ChassisMaterials({key})/UploadFile(File={file}) | |
DeleteFile | WS-ModifyFile | integration/api/odata/ChassisMaterials({key})/DeleteFile(FileName={filename}) | |
ChassisMaterials Functions
|
Function | Required Permission(s) | Link | Description |
---|
SearchChassisByMaterialSlots | WS-ReadChassis | integration/api/odata/ChassisMaterials({key})/SearchChassisByMaterialSlots | |
DownloadFile | WS-ReadFile | integration/api/odata/ChassisMaterials({key})/DownloadFile(FileName={filename}) | |
GetAuditLogData | WS-ReadAuditLog | integration/api/odata/ChassisMaterials({key})/GetAuditLogData | Function used to export all audit information for a specific entity. Please use the following Content-Type:application/vnd.openxmlformats-officedocument.spreadsheetml.sheet for file download |
ChassisMaterials Custom Routes
|
CustomRoute | Required Permission(s) | Supported Method(s) | Description |
---|
integration/api/odata/ChassisMaterials/In(Ids={ids}) | |
GET
| |
integration/api/odata/ChassisMaterials/NotIn(Ids={ids}) | |
GET
| |
integration/api/odata/ChassisMaterials({key})/Files | |
DELETE
| |
ChassisMaterials Nested Properties
No nested properties
Verb(s) | Required Permission(s) | Link | Description |
---|
GET | | integration/api/odata/CloudProviders | |
GET | | integration/api/odata/CloudProviders({key}) | |
CloudProviders Actions
No actions
CloudProviders Functions
No functions
CloudProviders Custom Routes
|
CustomRoute | Required Permission(s) | Supported Method(s) | Description |
---|
integration/api/odata/CloudProviders/In(Ids={ids}) | |
GET
| |
integration/api/odata/CloudProviders/NotIn(Ids={ids}) | |
GET
| |
CloudProviders Nested Properties
No nested properties
Verb(s) | Required Permission(s) | Link | Description |
---|
GET | WS-ReadNetworkConnection,WS-ReadAssetToAssetMapping | integration/api/odata/Connections | |
GET | WS-ReadNetworkConnection,WS-ReadAssetToAssetMapping | integration/api/odata/Connections({key}) | |
Connections Actions
No actions
Connections Functions
No functions
Connections Custom Routes
No custom routes
Connections Nested Properties
No nested properties
Verb(s) | Required Permission(s) | Link | Description |
---|
GET | | integration/api/odata/CrossSectionalAreas | |
GET | | integration/api/odata/CrossSectionalAreas({key}) | |
CrossSectionalAreas Actions
No actions
CrossSectionalAreas Functions
No functions
CrossSectionalAreas Custom Routes
No custom routes
CrossSectionalAreas Nested Properties
No nested properties
Verb(s) | Required Permission(s) | Link | Description |
---|
GET | | integration/api/odata/Cultures | |
GET | | integration/api/odata/Cultures({key}) | |
Cultures Actions
No actions
Cultures Functions
No functions
Cultures Custom Routes
|
CustomRoute | Required Permission(s) | Supported Method(s) | Description |
---|
integration/api/odata/Cultures/In(Ids={ids}) | |
GET
| |
integration/api/odata/Cultures/NotIn(Ids={ids}) | |
GET
| |
Cultures Nested Properties
No nested properties
Verb(s) | Required Permission(s) | Link | Description |
---|
GET | | integration/api/odata/CustomFieldTypes | |
GET | | integration/api/odata/CustomFieldTypes({key}) | |
CustomFieldTypes Actions
No actions
CustomFieldTypes Functions
No functions
CustomFieldTypes Custom Routes
|
CustomRoute | Required Permission(s) | Supported Method(s) | Description |
---|
integration/api/odata/CustomFieldTypes/In(Ids={ids}) | |
GET
| |
integration/api/odata/CustomFieldTypes/NotIn(Ids={ids}) | |
GET
| |
CustomFieldTypes Nested Properties
No nested properties
Verb(s) | Required Permission(s) | Link | Description |
---|
DELETE | WS-ModifyExclusionDate | integration/api/odata/ExclusionDates({key}) | |
POST | WS-AddExclusionDate | integration/api/odata/ExclusionDates | |
POST | | integration/api/odata/ExclusionDates({key}) | |
PATCH | WS-ModifyExclusionDate | integration/api/odata/ExclusionDates({key}) | |
GET | | integration/api/odata/ExclusionDates | |
GET | | integration/api/odata/ExclusionDates({key}) | |
ExclusionDates Actions
No actions
ExclusionDates Functions
No functions
ExclusionDates Custom Routes
|
CustomRoute | Required Permission(s) | Supported Method(s) | Description |
---|
integration/api/odata/ExclusionDates/In(Ids={ids}) | |
GET
| |
integration/api/odata/ExclusionDates/NotIn(Ids={ids}) | |
GET
| |
ExclusionDates Nested Properties
No nested properties
Verb(s) | Required Permission(s) | Link | Description |
---|
GET | WS-ReadFloorPlan | integration/api/odata/Floors | |
POST | WS-ModifyFloorPlan | integration/api/odata/Floors | |
PUT | WS-ModifyFloorPlan | integration/api/odata/Floors({key}) | |
DELETE | | integration/api/odata/Floors({key}) | |
GET | WS-ReadFloorPlan | integration/api/odata/Floors({key}) | |
Floors Actions
No actions
Floors Functions
|
Function | Required Permission(s) | Link | Description |
---|
LoadFloor | WS-ReadFloorPlan | integration/api/odata/Floors/LoadFloor(floorLocationGroupId={floorlocationgroupid}) | |
GetLocationWeight | WS-ReadFloorPlan | integration/api/odata/Floors({key})/GetLocationWeight | |
Floors Custom Routes
No custom routes
Floors Nested Properties
No nested properties
Verb(s) | Required Permission(s) | Link | Description |
---|
POST | WS-AddAuxiliaryMaterial | integration/api/odata/FlywheelGeneratorAuxiliaryMaterials | |
PATCH | WS-ModifyAuxiliaryMaterial | integration/api/odata/FlywheelGeneratorAuxiliaryMaterials({key}) | |
DELETE | WS-ModifyAuxiliaryMaterial | integration/api/odata/FlywheelGeneratorAuxiliaryMaterials({key}) | |
GET | WS-ReadAuxiliaryMaterial | integration/api/odata/FlywheelGeneratorAuxiliaryMaterials | |
GET | WS-ReadAuxiliaryMaterial | integration/api/odata/FlywheelGeneratorAuxiliaryMaterials({key}) | |
FlywheelGeneratorAuxiliaryMaterials Actions
|
Action | Required Permission(s) | Link | Description |
---|
Cancel | WS-ModifyAuxiliaryMaterial | integration/api/odata/FlywheelGeneratorAuxiliaryMaterials({key})/Cancel | |
Activate | WS-ModifyAuxiliaryMaterial | integration/api/odata/FlywheelGeneratorAuxiliaryMaterials({key})/Activate | Function that will move a material in Active status. |
Deactivate | WS-ModifyAuxiliaryMaterial | integration/api/odata/FlywheelGeneratorAuxiliaryMaterials({key})/Deactivate | Function that will move a material in Inactive status. |
UploadFile | WS-AddFile | integration/api/odata/FlywheelGeneratorAuxiliaryMaterials({key})/UploadFile(File={file}) | |
DeleteFile | WS-ModifyFile | integration/api/odata/FlywheelGeneratorAuxiliaryMaterials({key})/DeleteFile(FileName={filename}) | |
FlywheelGeneratorAuxiliaryMaterials Functions
|
Function | Required Permission(s) | Link | Description |
---|
DownloadFile | WS-ReadFile | integration/api/odata/FlywheelGeneratorAuxiliaryMaterials({key})/DownloadFile(FileName={filename}) | |
GetAuditLogData | WS-ReadAuditLog | integration/api/odata/FlywheelGeneratorAuxiliaryMaterials({key})/GetAuditLogData | Function used to export all audit information for a specific entity. Please use the following Content-Type:application/vnd.openxmlformats-officedocument.spreadsheetml.sheet for file download |
FlywheelGeneratorAuxiliaryMaterials Custom Routes
|
CustomRoute | Required Permission(s) | Supported Method(s) | Description |
---|
integration/api/odata/FlywheelGeneratorAuxiliaryMaterials/In(Ids={ids}) | |
GET
| |
integration/api/odata/FlywheelGeneratorAuxiliaryMaterials/NotIn(Ids={ids}) | |
GET
| |
integration/api/odata/FlywheelGeneratorAuxiliaryMaterials({key})/Files | |
DELETE
| |
FlywheelGeneratorAuxiliaryMaterials Nested Properties
No nested properties
Verb(s) | Required Permission(s) | Link | Description |
---|
GET | | integration/api/odata/FormBuilderMetaDataLists | |
GET | | integration/api/odata/FormBuilderMetaDataLists({key}) | |
FormBuilderMetaDataLists Actions
No actions
FormBuilderMetaDataLists Functions
No functions
FormBuilderMetaDataLists Custom Routes
|
CustomRoute | Required Permission(s) | Supported Method(s) | Description |
---|
integration/api/odata/FormBuilderMetaDataLists/In(Ids={ids}) | |
GET
| |
integration/api/odata/FormBuilderMetaDataLists/NotIn(Ids={ids}) | |
GET
| |
FormBuilderMetaDataLists Nested Properties
No nested properties
Verb(s) | Required Permission(s) | Link | Description |
---|
PUT | WS-ModifyForm | integration/api/odata/Forms({key}) | |
POST | WS-AddForm | integration/api/odata/Forms | |
POST | | integration/api/odata/Forms({key}) | |
PATCH | WS-ModifyForm | integration/api/odata/Forms({key}) | |
GET | WS-ReadForm | integration/api/odata/Forms | |
GET | WS-ReadForm | integration/api/odata/Forms({key}) | |
Forms Actions
|
Action | Required Permission(s) | Link | Description |
---|
Copy | WS-AddForm | integration/api/odata/Forms({key})/Copy(Name={name}, Description={description}) | |
Import | WS-ReadForm | integration/api/odata/Forms/Import | |
SetStatus | WS-ModifyForm | integration/api/odata/Forms({key})/SetStatus(Status={status}) | |
Forms Functions
|
Function | Required Permission(s) | Link | Description |
---|
Export | WS-ReadForm | integration/api/odata/Forms({key})/Export | |
SqlViews | WS-ReadSqlView | integration/api/odata/Forms/SqlViews | |
SqlViewValues | WS-ReadSqlView | integration/api/odata/Forms/SqlViewValues(ViewName={viewname}) | |
Forms Custom Routes
|
CustomRoute | Required Permission(s) | Supported Method(s) | Description |
---|
integration/api/odata/Forms | |
POST
| |
integration/api/odata/Forms/In(Ids={ids}) | |
GET
| |
integration/api/odata/Forms/NotIn(Ids={ids}) | |
GET
| |
Forms Nested Properties
No nested properties
Verb(s) | Required Permission(s) | Link | Description |
---|
GET | WS-ReadAssetToAssetMapping | integration/api/odata/Graphs | |
GET | WS-ReadAssetToAssetMapping | integration/api/odata/Graphs({key}) | |
Graphs Actions
No actions
Graphs Functions
No functions
Graphs Custom Routes
No custom routes
Graphs Nested Properties
No nested properties
Verb(s) | Required Permission(s) | Link | Description |
---|
GET | WS-ReadBusinessGroup,WS-ReadSupportGroup | integration/api/odata/Groups({key}) | |
GET | WS-ReadBusinessGroup,WS-ReadSupportGroup | integration/api/odata/Groups | |
GET | WS-ReadBusinessGroup,WS-ReadSupportGroup | integration/api/odata/Groups({key}) | |
Groups Actions
No actions
Groups Functions
No functions
Groups Custom Routes
No custom routes
Groups Nested Properties
No nested properties
Verb(s) | Required Permission(s) | Link | Description |
---|
GET | WS-ReadProcess | integration/api/odata/IntegrationSystems | |
GET | WS-ReadProcess | integration/api/odata/IntegrationSystems({key}) | |
IntegrationSystems Actions
No actions
IntegrationSystems Functions
No functions
IntegrationSystems Custom Routes
|
CustomRoute | Required Permission(s) | Supported Method(s) | Description |
---|
integration/api/odata/IntegrationSystems/In(Ids={ids}) | |
GET
| |
integration/api/odata/IntegrationSystems/NotIn(Ids={ids}) | |
GET
| |
IntegrationSystems Nested Properties
No nested properties
Verb(s) | Required Permission(s) | Link | Description |
---|
GET | WS-ReadInternalEquipmentItem | integration/api/odata/InternalEquipmentCategories | |
GET | WS-ReadInternalEquipmentItem | integration/api/odata/InternalEquipmentCategories({key}) | |
InternalEquipmentCategories Actions
No actions
InternalEquipmentCategories Functions
No functions
InternalEquipmentCategories Custom Routes
|
CustomRoute | Required Permission(s) | Supported Method(s) | Description |
---|
integration/api/odata/InternalEquipmentCategories/In(Ids={ids}) | |
GET
| |
integration/api/odata/InternalEquipmentCategories/NotIn(Ids={ids}) | |
GET
| |
InternalEquipmentCategories Nested Properties
No nested properties
Verb(s) | Required Permission(s) | Link | Description |
---|
POST | WS-AddInternalEquipmentItem | integration/api/odata/InternalEquipmentItems | |
DELETE | WS-ModifyInternalEquipmentItem | integration/api/odata/InternalEquipmentItems({key}) | |
PATCH | WS-ModifyInternalEquipmentItem | integration/api/odata/InternalEquipmentItems({key}) | |
GET | WS-ReadInternalEquipmentItem | integration/api/odata/InternalEquipmentItems | |
GET | WS-ReadInternalEquipmentItem | integration/api/odata/InternalEquipmentItems({key}) | |
InternalEquipmentItems Actions
No actions
InternalEquipmentItems Functions
No functions
InternalEquipmentItems Custom Routes
|
CustomRoute | Required Permission(s) | Supported Method(s) | Description |
---|
integration/api/odata/InternalEquipmentItems({key})/Notes({relatedKey}) | |
GET
| |
integration/api/odata/InternalEquipmentItems({key})/Notes | |
GET
| |
integration/api/odata/InternalEquipmentItems({key})/Notes | |
POST
| |
integration/api/odata/InternalEquipmentItems({key})/Notes | |
DELETE
| |
integration/api/odata/InternalEquipmentItems({key})/Notes({relatedKey}) | |
DELETE
| |
integration/api/odata/InternalEquipmentItems({key})/Notes({relatedKey}) | |
PATCH
| |
InternalEquipmentItems Nested Properties
No nested properties
Verb(s) | Required Permission(s) | Link | Description |
---|
POST | WS-AddInternalEquipmentItemUtilisation | integration/api/odata/InternalEquipmentItemUtilisations | |
DELETE | WS-ModifyInternalEquipmentItemUtilisation | integration/api/odata/InternalEquipmentItemUtilisations({key}) | |
PATCH | WS-ModifyInternalEquipmentItemUtilisation | integration/api/odata/InternalEquipmentItemUtilisations({key}) | |
GET | WS-ReadInternalEquipmentItemUtilisation | integration/api/odata/InternalEquipmentItemUtilisations | |
GET | WS-ReadInternalEquipmentItemUtilisation | integration/api/odata/InternalEquipmentItemUtilisations({key}) | |
InternalEquipmentItemUtilisations Actions
No actions
InternalEquipmentItemUtilisations Functions
No functions
InternalEquipmentItemUtilisations Custom Routes
No custom routes
InternalEquipmentItemUtilisations Nested Properties
No nested properties
Verb(s) | Required Permission(s) | Link | Description |
---|
POST | | integration/api/odata/IPAddresses | |
PATCH | | integration/api/odata/IPAddresses({key}) | |
DELETE | | integration/api/odata/IPAddresses({key}) | |
GET | | integration/api/odata/IPAddresses | |
GET | | integration/api/odata/IPAddresses({key}) | |
IPAddresses Actions
No actions
IPAddresses Functions
No functions
IPAddresses Custom Routes
|
CustomRoute | Required Permission(s) | Supported Method(s) | Description |
---|
integration/api/odata/IPAddresses/In(Ids={ids}) | |
GET
| |
integration/api/odata/IPAddresses/NotIn(Ids={ids}) | |
GET
| |
IPAddresses Nested Properties
No nested properties
Verb(s) | Required Permission(s) | Link | Description |
---|
POST | WS-AddPeripheralMaterial | integration/api/odata/KeyboardPeripheralMaterials | |
PATCH | WS-ModifyPeripheralMaterial | integration/api/odata/KeyboardPeripheralMaterials({key}) | |
DELETE | WS-ModifyPeripheralMaterial | integration/api/odata/KeyboardPeripheralMaterials({key}) | |
GET | WS-ReadPeripheralMaterial | integration/api/odata/KeyboardPeripheralMaterials | |
GET | WS-ReadPeripheralMaterial | integration/api/odata/KeyboardPeripheralMaterials({key}) | |
KeyboardPeripheralMaterials Actions
|
Action | Required Permission(s) | Link | Description |
---|
Cancel | WS-ModifyPeripheralMaterial | integration/api/odata/KeyboardPeripheralMaterials({key})/Cancel | |
Activate | WS-ModifyPeripheralMaterial | integration/api/odata/KeyboardPeripheralMaterials({key})/Activate | Function that will move a material in Active status. |
Deactivate | WS-ModifyPeripheralMaterial | integration/api/odata/KeyboardPeripheralMaterials({key})/Deactivate | Function that will move a material in Inactive status. |
UploadFile | WS-AddFile | integration/api/odata/KeyboardPeripheralMaterials({key})/UploadFile(File={file}) | |
DeleteFile | WS-ModifyFile | integration/api/odata/KeyboardPeripheralMaterials({key})/DeleteFile(FileName={filename}) | |
KeyboardPeripheralMaterials Functions
|
Function | Required Permission(s) | Link | Description |
---|
DownloadFile | WS-ReadFile | integration/api/odata/KeyboardPeripheralMaterials({key})/DownloadFile(FileName={filename}) | |
GetAuditLogData | WS-ReadAuditLog | integration/api/odata/KeyboardPeripheralMaterials({key})/GetAuditLogData | Function used to export all audit information for a specific entity. Please use the following Content-Type:application/vnd.openxmlformats-officedocument.spreadsheetml.sheet for file download |
KeyboardPeripheralMaterials Custom Routes
|
CustomRoute | Required Permission(s) | Supported Method(s) | Description |
---|
integration/api/odata/KeyboardPeripheralMaterials/In(Ids={ids}) | |
GET
| |
integration/api/odata/KeyboardPeripheralMaterials/NotIn(Ids={ids}) | |
GET
| |
integration/api/odata/KeyboardPeripheralMaterials({key})/Files | |
DELETE
| |
KeyboardPeripheralMaterials Nested Properties
No nested properties
Verb(s) | Required Permission(s) | Link | Description |
---|
POST | WS-ModifyKVMSwitch | integration/api/odata/KVMSwitches({key}) | |
POST | WS-AddKVMSwitch | integration/api/odata/KVMSwitches | |
PATCH | WS-ModifyKVMSwitch | integration/api/odata/KVMSwitches({key}) | |
DELETE | WS-ModifyKVMSwitch | integration/api/odata/KVMSwitches({key}) | |
GET | WS-ReadKVMSwitch | integration/api/odata/KVMSwitches | |
GET | WS-ReadKVMSwitch | integration/api/odata/KVMSwitches({key}) | |
KVMSwitches Actions
|
Action | Required Permission(s) | Link | Description |
---|
BeginMove | WS-PlanMoveKVMSwitch, WS-PlanRecycleKVMSwitch, WS-PlanDecommissionKVMSwitch | integration/api/odata/KVMSwitches({key})/BeginMove(RelocateType={relocatetype}) | Function that is used to move the selected asset in a planned state, Moving, Recycling or Decommissioning, depending on the RelocateType provided as parameter. The response contains the Planned AssetId. |
CancelMove | WS-CancelMoveKVMSwitch, WS-CancelRecycleKVMSwitch, WS-CancelDecommissionKVMSwitch | integration/api/odata/KVMSwitches({key})/CancelMove | Function that is used to cancel planned action. The selected asset will become Active/Operational. |
CompleteMove | WS-CompleteMoveKVMSwitch, WS-CompleteRecycleKVMSwitch, WS-CompleteDecommissionKVMSwitch | integration/api/odata/KVMSwitches({key})/CompleteMove | Function that is used to finish planned action. The selected asset will become Active/Operational, Recycled/Available or Decommissioned/Decommissioned, depending on the Planned entity type (Move, Recycle or Deccommission). |
DirectMove | WS-SetLocationKVMSwitch | integration/api/odata/KVMSwitches({key})/DirectMove(RelocateType={relocatetype}, LocationGroupID={locationgroupid}) | Function that is used to directly move an asset to a new location in a final state. |
CompleteCreation | WS-ModifyKVMSwitch | integration/api/odata/KVMSwitches({key})/CompleteCreation | Function that moves an asset from Planned/(Pre)Procurement to Active/Operational. |
SetMaterial | | integration/api/odata/KVMSwitches({key})/SetMaterial(NewMaterialID={newmaterialid}) | Function that is used to change the material on an existing asset. This action is only supported for Receptacles and Power Strips. |
AddRealTimeValues | WS-AddAssetRealtimeData | integration/api/odata/KVMSwitches({key})/AddRealTimeValues(RealTimeInfo={realtimeinfo}, RealTimeValue={realtimevalue}) | Adds a provider specfic recorded real-time value against an asset or its associated outlet. Custom metrics are only allowed on assets whereas load, power and voltage metrics are allowed against assets, outlets or their relevant phases. |
AddNetworkAsset | WS-ReadNetworkConnection,WS-AddNetworkConnection | integration/api/odata/KVMSwitches({key})/AddNetworkAsset(NetworkAssetId={networkassetid}) | Function that is adding the selected asset in the list of available asset to be used in network connections. The mapping between the two assets is created by providing the NetworkAssetId parameter in the BODY, NetworkAssetId representing the AssetID of the asset to be added in the list of available assets. |
RemoveNetworkAsset | WS-ModifyNetworkConnection | integration/api/odata/KVMSwitches({key})/RemoveNetworkAsset(NetworkAssetId={networkassetid}, NetworkLinkerType={networklinkertype}) | Function that removes an asset from the association list of available asset to be used in network connections. |
UploadFile | WS-AddFile | integration/api/odata/KVMSwitches({key})/UploadFile(File={file}) | |
DeleteFile | WS-ModifyFile | integration/api/odata/KVMSwitches({key})/DeleteFile(FileName={filename}) | |
KVMSwitches Functions
|
Function | Required Permission(s) | Link | Description |
---|
ListLinkedRecords | | integration/api/odata/KVMSwitches/ListLinkedRecords(assetIds={assetids}) | Retrieves a collection of assets, associated to the selected asset that will be affected by a potential move action. |
GetTotalSystemPowerConsumption | WS-ReadKVMSwitch | integration/api/odata/KVMSwitches({key})/GetTotalSystemPowerConsumption | Function that returns the TotalSystemPowerConsumption for the selected asset. |
GetRealTimePowerInfo | WS-ReadKVMSwitch | integration/api/odata/KVMSwitches({key})/GetRealTimePowerInfo | |
GetDiscoveryAssetPage | WS-ReadKVMSwitch | integration/api/odata/KVMSwitches({key})/GetDiscoveryAssetPage | Function that returns a collection of entities of type Nlyte.Model.AssetMapping. Used to determine external providers. |
RecordModifiedInfo | WS-ReadKVMSwitch | integration/api/odata/KVMSwitches({key})/RecordModifiedInfo | Function that returns an entity of type Nlyte.Model.AuditLogInfo and provides information regarding last modifications against the current asset |
GetMountedChildAssets | | integration/api/odata/KVMSwitches({key})/GetMountedChildAssets(IncludeHosts={includehosts}, IncludeCards={includecards}) | Function that returns a collection of entities of type Nlyte.Model.MountedAssetSummary representing the list of mounted assets in the provided asset. The function is called as follows: Assets(AssetID)/GetMountedChildAssets(IncludeHosts=true,IncludeCards=true) where AssetID is the parent for which the children are retrieved. |
GetDistributorsWithFreeOutlets | WS-ReadAssetToAssetMapping | integration/api/odata/KVMSwitches({key})/GetDistributorsWithFreeOutlets(SearchTerm={searchterm}, SearchTermOption={searchtermoption}, LocationDepth={locationdepth}, MaterialTypeID={materialtypeid}, MaterialSubtypeID={materialsubtypeid}) | Function that returns a collection of entities of type Nlyte.Model.Distributor representing available power suppliers. |
SearchAssetNetworkPortLinkage | WS-ReadNetworkConnection | integration/api/odata/KVMSwitches({key})/SearchAssetNetworkPortLinkage(SearchTerm={searchterm}, SearchTermOption={searchtermoption}, CabinetMountingStatus={cabinetmountingstatus}, LocationTarget={locationtarget}, NetworkTypes={networktypes}, PortLocation={portlocation}) | Function that returns a collection of entities of type Nlyte.Model.AssetNetworkPortLinkage representing available assets to be used in network connections. |
GetRealTimeValues | WS-ReadAssetRealtimeData | integration/api/odata/KVMSwitches({key})/GetRealTimeValues | Function that returns a collection of entities of type Nlyte.Model.RealTimeValue. |
GetAssetSummaries | | integration/api/odata/KVMSwitches({key})/GetAssetSummaries(OwnedPeripherals={ownedperipherals}, IncludeHosts={includehosts}) | |
GetNetworkCardPortsInfo | WS-ReadNetworkConnection | integration/api/odata/KVMSwitches({key})/GetNetworkCardPortsInfo | Returns an object of type Nlyte.Model.NetworkResults having information about Copper and Fiber Ports |
GetNetworkCardPortConnections | WS-ReadNetworkConnection | integration/api/odata/KVMSwitches({key})/GetNetworkCardPortConnections | Returns an object of type Nlyte.Model.NetworkResults having information about Copper and Fiber Port connections |
GetNetworkAssetSummary | WS-ReadNetworkConnection | integration/api/odata/KVMSwitches({key})/GetNetworkAssetSummary | Returns an object of type Nlyte.Model.NetworkResults having information about the networkable assets. |
ListPowerConsumers | | integration/api/odata/KVMSwitches({key})/ListPowerConsumers | Function that returns a collection of Nlyte.Model.Graph entities. Used to identify available Output Connector used in power connections. |
SupportsPlannedMove | | integration/api/odata/KVMSwitches({key})/SupportsPlannedMove | |
GetTotalSystemWeight | | integration/api/odata/KVMSwitches({key})/GetTotalSystemWeight | Function that returns the TotalSystemWeight for the selected asset. |
GetMountedOnAssetID | | integration/api/odata/KVMSwitches({key})/GetMountedOnAssetID | |
GetAssetsReportData | WS-ReadNetwork,WS-ReadCabinet,WS-ReadPeripheral,WS-ReadKVMSwitch,WS-ReadServer,WS-ReadPDU,WS-ReadPowerStrip,WS-ReadAirConditioning,WS-ReadReceptacle,WS-ReadChassis,WS-ReadUPS,WS-ReadAuxiliary,WS-ReadStaticSwitch,WS-ReadServerHost | integration/api/odata/KVMSwitches/GetAssetsReportData(assetIds={assetids}) | |
DownloadFile | WS-ReadFile | integration/api/odata/KVMSwitches({key})/DownloadFile(FileName={filename}) | |
GetAuditLogData | WS-ReadAuditLog | integration/api/odata/KVMSwitches({key})/GetAuditLogData | Function used to export all audit information for a specific entity. Please use the following Content-Type:application/vnd.openxmlformats-officedocument.spreadsheetml.sheet for file download |
KVMSwitches Custom Routes
|
CustomRoute | Required Permission(s) | Supported Method(s) | Description |
---|
integration/api/odata/KVMSwitches({key})/Notes({relatedKey}) | |
GET
| |
integration/api/odata/KVMSwitches({key})/Notes | |
GET
| |
integration/api/odata/KVMSwitches({key})/Notes | |
POST
| |
integration/api/odata/KVMSwitches({key})/Notes | |
DELETE
| |
integration/api/odata/KVMSwitches({key})/Notes({relatedKey}) | |
DELETE
| |
integration/api/odata/KVMSwitches({key})/Notes({relatedKey}) | |
PATCH
| |
integration/api/odata/KVMSwitches({key})/Peripherals({relatedKey})/Notes({nestedRelatedKey}) | |
GET
| |
integration/api/odata/KVMSwitches({key})/Peripherals({relatedKey})/Notes | |
GET
| |
integration/api/odata/KVMSwitches({key})/Peripherals({relatedKey})/Notes({nestedRelatedKey}) | |
PATCH
| |
integration/api/odata/KVMSwitches({key})/Peripherals({relatedKey})/Notes | |
POST
| |
integration/api/odata/KVMSwitches({key})/Peripherals({relatedKey})/Notes | |
DELETE
| |
integration/api/odata/KVMSwitches({key})/Peripherals({relatedKey})/Notes({nestedRelatedKey}) | |
DELETE
| |
integration/api/odata/KVMSwitches({key})/Graphs | |
GET
| |
integration/api/odata/KVMSwitches({key})/Graphs({relatedKey}) | |
GET
| |
integration/api/odata/KVMSwitches({key})/Graphs({relatedKey}) | |
PATCH
| |
integration/api/odata/KVMSwitches({key})/Graphs | |
POST
| |
integration/api/odata/KVMSwitches({key})/Graphs({relatedKey}) | |
DELETE
| |
integration/api/odata/KVMSwitches({key})/GetAvailableCabinetUs(CabinetID={cabinetId}) | WS-ReadCabinet |
GET
| |
integration/api/odata/KVMSwitches({key})/AssetPortConsumerLinks | |
POST
| |
integration/api/odata/KVMSwitches({key})/AssetPortConsumerLinks({relatedKey}) | WS-ModifyKVMSwitchPortConsumerLink |
DELETE
| |
integration/api/odata/KVMSwitches({key})/KvmSwitchPortConsumerLinks({relatedKey}) | WS-ModifyKVMSwitchPortConsumerLink |
DELETE
| |
integration/api/odata/KVMSwitches({key})/AssetPortConsumerLinks | |
PATCH
| |
integration/api/odata/KVMSwitches({key})/AssociatedAssets({relatedKey}) | |
DELETE
| |
integration/api/odata/KVMSwitches({key})/AssociatedAssets({relatedKey})/Notes({nestedRelatedKey}) | |
GET
| |
integration/api/odata/KVMSwitches({key})/AssociatedAssets({relatedKey})/Notes | |
GET
| |
integration/api/odata/KVMSwitches({key})/AssociatedAssets({relatedKey})/Notes({nestedRelatedKey}) | |
PATCH
| |
integration/api/odata/KVMSwitches({key})/AssociatedAssets({relatedKey})/Notes | |
POST
| |
integration/api/odata/KVMSwitches({key})/AssociatedAssets({relatedKey})/Notes | |
DELETE
| |
integration/api/odata/KVMSwitches({key})/AssociatedAssets({relatedKey})/Notes({nestedRelatedKey}) | |
DELETE
| |
integration/api/odata/KVMSwitches({key})/Peripherals | |
POST
| |
integration/api/odata/KVMSwitches({key})/Peripherals({relatedKey}) | |
DELETE
| |
integration/api/odata/KVMSwitches({key})/GetServiceRequests | |
GET
| |
integration/api/odata/KVMSwitches({key})/CustomFields | WS-ReadCustomFieldKVMSwitch |
GET
| |
integration/api/odata/KVMSwitches({key})/CustomFields | WS-ModifyCustomFieldKVMSwitch |
POST
| |
integration/api/odata/KVMSwitches({key})/CustomFields({relatedKey}) | WS-ModifyCustomFieldKVMSwitch |
PATCH
| |
integration/api/odata/KVMSwitches({key})/CustomFields({relatedKey}) | WS-ModifyCustomFieldKVMSwitch |
DELETE
| |
integration/api/odata/KVMSwitches({key})/Warranty | WS-ReadKVMSwitch |
GET
| |
integration/api/odata/KVMSwitches({key})/Warranty | WS-ModifyKVMSwitch |
POST
| |
integration/api/odata/KVMSwitches({key})/Warranty | WS-ModifyKVMSwitch |
PATCH
| |
integration/api/odata/KVMSwitches({key})/Warranty | WS-ModifyKVMSwitch |
DELETE
| |
integration/api/odata/KVMSwitches({key})/Maintenance | WS-ReadKVMSwitch |
GET
| |
integration/api/odata/KVMSwitches({key})/Maintenance | WS-ModifyKVMSwitch |
POST
| |
integration/api/odata/KVMSwitches({key})/Maintenance | WS-ModifyKVMSwitch |
PATCH
| |
integration/api/odata/KVMSwitches({key})/Maintenance | WS-ModifyKVMSwitch |
DELETE
| |
integration/api/odata/KVMSwitches({key})/AssetMounting | |
GET
| |
integration/api/odata/KVMSwitches({key})/Ownership | WS-ReadBusinessGroupAssetMap |
GET
| |
integration/api/odata/KVMSwitches({key})/Ownership({relatedKey}) | WS-ReadBusinessGroupAssetMap |
GET
| |
integration/api/odata/KVMSwitches({key})/Ownership | WS-AddBusinessGroupAssetMap |
POST
| |
integration/api/odata/KVMSwitches({key})/Ownership({relatedKey}) | WS-ModifyBusinessGroupAssetMap |
PATCH
| |
integration/api/odata/KVMSwitches({key})/Ownership({relatedKey}) | WS-ModifyBusinessGroupAssetMap |
DELETE
| |
integration/api/odata/KVMSwitches({key})/Support | WS-ReadSupportGroupAssetMap |
GET
| |
integration/api/odata/KVMSwitches({key})/Support({relatedKey}) | WS-ReadSupportGroupAssetMap |
GET
| |
integration/api/odata/KVMSwitches({key})/Support | WS-AddSupportGroupAssetMap |
POST
| |
integration/api/odata/KVMSwitches({key})/Support({relatedKey}) | WS-ModifySupportGroupAssetMap |
PATCH
| |
integration/api/odata/KVMSwitches({key})/Support({relatedKey}) | WS-ModifySupportGroupAssetMap |
DELETE
| |
integration/api/odata/KVMSwitches/In(Ids={ids}) | |
GET
| |
integration/api/odata/KVMSwitches/NotIn(Ids={ids}) | |
GET
| |
integration/api/odata/KVMSwitches({key})/Files | |
DELETE
| |
KVMSwitches Nested Properties
|
NestedProperty | Supported Method(s) |
---|
Ownership |
BIND
POST
PATCH
|
Support |
BIND
POST
PATCH
|
CustomFields |
POST
PATCH
|
Maintenance |
POST
PATCH
|
Warranty |
POST
PATCH
|
AssetIPAddressMap |
POST
PATCH
|
LocationGroup | |
AssociatedAssets |
BIND
|
Cabinets |
POST
|
AssetPortConsumerLinks |
POST
PATCH
|
Peripherals |
BIND
POST
PATCH
|
InputConnectors |
PATCH
|
Graphs |
POST
PATCH
|
UMounting |
POST
PATCH
|
Verb(s) | Required Permission(s) | Link | Description |
---|
POST | WS-ModifyKVMSwitchMaterial | integration/api/odata/KVMSwitchMaterials({key}) | |
POST | WS-AddKVMSwitchMaterial | integration/api/odata/KVMSwitchMaterials | |
PATCH | WS-ModifyKVMSwitchMaterial | integration/api/odata/KVMSwitchMaterials({key}) | |
DELETE | WS-ModifyKVMSwitchMaterial | integration/api/odata/KVMSwitchMaterials({key}) | |
GET | WS-ReadKVMSwitchMaterial | integration/api/odata/KVMSwitchMaterials | |
GET | WS-ReadKVMSwitchMaterial | integration/api/odata/KVMSwitchMaterials({key}) | |
KVMSwitchMaterials Actions
|
Action | Required Permission(s) | Link | Description |
---|
Cancel | WS-ModifyKVMSwitchMaterial | integration/api/odata/KVMSwitchMaterials({key})/Cancel | |
Activate | WS-ModifyKVMSwitchMaterial | integration/api/odata/KVMSwitchMaterials({key})/Activate | Function that will move a material in Active status. |
Deactivate | WS-ModifyKVMSwitchMaterial | integration/api/odata/KVMSwitchMaterials({key})/Deactivate | Function that will move a material in Inactive status. |
UploadFile | WS-AddFile | integration/api/odata/KVMSwitchMaterials({key})/UploadFile(File={file}) | |
DeleteFile | WS-ModifyFile | integration/api/odata/KVMSwitchMaterials({key})/DeleteFile(FileName={filename}) | |
KVMSwitchMaterials Functions
|
Function | Required Permission(s) | Link | Description |
---|
DownloadFile | WS-ReadFile | integration/api/odata/KVMSwitchMaterials({key})/DownloadFile(FileName={filename}) | |
GetAuditLogData | WS-ReadAuditLog | integration/api/odata/KVMSwitchMaterials({key})/GetAuditLogData | Function used to export all audit information for a specific entity. Please use the following Content-Type:application/vnd.openxmlformats-officedocument.spreadsheetml.sheet for file download |
KVMSwitchMaterials Custom Routes
|
CustomRoute | Required Permission(s) | Supported Method(s) | Description |
---|
integration/api/odata/KVMSwitchMaterials/In(Ids={ids}) | |
GET
| |
integration/api/odata/KVMSwitchMaterials/NotIn(Ids={ids}) | |
GET
| |
integration/api/odata/KVMSwitchMaterials({key})/Files | |
DELETE
| |
KVMSwitchMaterials Nested Properties
No nested properties
Verb(s) | Required Permission(s) | Link | Description |
---|
GET | | integration/api/odata/LayerImages({key}) | |
GET | | integration/api/odata/LayerImages | |
POST | | integration/api/odata/LayerImages | |
DELETE | | integration/api/odata/LayerImages({key}) | |
PATCH | | integration/api/odata/LayerImages({key}) | |
GET | | integration/api/odata/LayerImages({key}) | |
LayerImages Actions
|
Action | Required Permission(s) | Link | Description |
---|
NormalizeImage | WS-ModifyFloorPlan | integration/api/odata/LayerImages({key})/NormalizeImage | |
LayerImages Functions
No functions
LayerImages Custom Routes
|
CustomRoute | Required Permission(s) | Supported Method(s) | Description |
---|
integration/api/odata/CropFloorImagesToRoomLayers | WS-ModifyFloorPlan |
POST
| |
LayerImages Nested Properties
No nested properties
Verb(s) | Required Permission(s) | Link | Description |
---|
GET | | integration/api/odata/License | |
GET | | integration/api/odata/License({key}) | |
License Actions
No actions
License Functions
No functions
License Custom Routes
No custom routes
License Nested Properties
No nested properties
Verb(s) | Required Permission(s) | Link | Description |
---|
GET | | integration/api/odata/ListTypes | |
GET | | integration/api/odata/ListTypes({key}) | |
ListTypes Actions
No actions
ListTypes Functions
No functions
ListTypes Custom Routes
|
CustomRoute | Required Permission(s) | Supported Method(s) | Description |
---|
integration/api/odata/ListTypes/In(Ids={ids}) | |
GET
| |
integration/api/odata/ListTypes/NotIn(Ids={ids}) | |
GET
| |
ListTypes Nested Properties
No nested properties
Verb(s) | Required Permission(s) | Link | Description |
---|
DELETE | | integration/api/odata/LocationGroups({key}) | |
GET | | integration/api/odata/LocationGroups | |
GET | | integration/api/odata/LocationGroups({key}) | |
LocationGroups Actions
No actions
LocationGroups Functions
|
Function | Required Permission(s) | Link | Description |
---|
Children | | integration/api/odata/LocationGroups/Children(key={key}) | |
Descendants | | integration/api/odata/LocationGroups/Descendants(key={key}) | |
LocationGroups Custom Routes
|
CustomRoute | Required Permission(s) | Supported Method(s) | Description |
---|
integration/api/odata/LocationGroups({key})/Notes({relatedKey}) | |
GET
| |
integration/api/odata/LocationGroups({key})/Notes | |
GET
| |
integration/api/odata/LocationGroups({key})/Notes | |
POST
| |
integration/api/odata/LocationGroups({key})/Notes | |
DELETE
| |
integration/api/odata/LocationGroups({key})/Notes({relatedKey}) | |
DELETE
| |
integration/api/odata/LocationGroups({key})/Notes({relatedKey}) | |
PATCH
| |
integration/api/odata/LocationGroups/In(Ids={ids}) | |
GET
| |
integration/api/odata/LocationGroups/NotIn(Ids={ids}) | |
GET
| |
LocationGroups Nested Properties
No nested properties
Verb(s) | Required Permission(s) | Link | Description |
---|
GET | | integration/api/odata/LogicalPartitionTypes | |
GET | | integration/api/odata/LogicalPartitionTypes({key}) | |
LogicalPartitionTypes Actions
No actions
LogicalPartitionTypes Functions
No functions
LogicalPartitionTypes Custom Routes
|
CustomRoute | Required Permission(s) | Supported Method(s) | Description |
---|
integration/api/odata/LogicalPartitionTypes/In(Ids={ids}) | |
GET
| |
integration/api/odata/LogicalPartitionTypes/NotIn(Ids={ids}) | |
GET
| |
LogicalPartitionTypes Nested Properties
No nested properties
Verb(s) | Required Permission(s) | Link | Description |
---|
GET | | integration/api/odata/Manufacturers | |
GET | | integration/api/odata/Manufacturers({key}) | |
Manufacturers Actions
No actions
Manufacturers Functions
No functions
Manufacturers Custom Routes
|
CustomRoute | Required Permission(s) | Supported Method(s) | Description |
---|
integration/api/odata/Manufacturers/In(Ids={ids}) | |
GET
| |
integration/api/odata/Manufacturers/NotIn(Ids={ids}) | |
GET
| |
Manufacturers Nested Properties
No nested properties
Verb(s) | Required Permission(s) | Link | Description |
---|
GET | WS-ReadPDUBreaker | integration/api/odata/MasterBreakers | |
GET | WS-ReadPDUBreaker | integration/api/odata/MasterBreakers({key}) | |
MasterBreakers Actions
No actions
MasterBreakers Functions
No functions
MasterBreakers Custom Routes
|
CustomRoute | Required Permission(s) | Supported Method(s) | Description |
---|
integration/api/odata/MasterBreakers/In(Ids={ids}) | |
GET
| |
integration/api/odata/MasterBreakers/NotIn(Ids={ids}) | |
GET
| |
MasterBreakers Nested Properties
No nested properties
Verb(s) | Required Permission(s) | Link | Description |
---|
GET | | integration/api/odata/MaterialCategories | |
GET | | integration/api/odata/MaterialCategories({key}) | |
MaterialCategories Actions
No actions
MaterialCategories Functions
No functions
MaterialCategories Custom Routes
|
CustomRoute | Required Permission(s) | Supported Method(s) | Description |
---|
integration/api/odata/MaterialCategories/In(Ids={ids}) | |
GET
| |
integration/api/odata/MaterialCategories/NotIn(Ids={ids}) | |
GET
| |
MaterialCategories Nested Properties
No nested properties
Verb(s) | Required Permission(s) | Link | Description |
---|
GET | | integration/api/odata/MaterialImages | |
GET | | integration/api/odata/MaterialImages({key}) | |
MaterialImages Actions
No actions
MaterialImages Functions
No functions
MaterialImages Custom Routes
|
CustomRoute | Required Permission(s) | Supported Method(s) | Description |
---|
integration/api/odata/MaterialImages/In(Ids={ids}) | |
GET
| |
integration/api/odata/MaterialImages/NotIn(Ids={ids}) | |
GET
| |
MaterialImages Nested Properties
No nested properties
Verb(s) | Required Permission(s) | Link | Description |
---|
GET | WS-ReadAirConditioningMaterial,WS-ReadAuxiliaryMaterial,WS-ReadCabinetMaterial,WS-ReadChassisMaterial,WS-ReadKVMSwitchMaterial,WS-ReadNetworkMaterial,WS-ReadPDUMaterial,WS-ReadPeripheralMaterial,WS-ReadPowerStripMaterial,WS-ReadReceptacleMaterial,WS-ReadServerMaterial,WS-ReadStaticSwitchMaterial,WS-ReadUPSMaterial | integration/api/odata/Materials | |
GET | WS-ReadAirConditioningMaterial,WS-ReadAuxiliaryMaterial,WS-ReadCabinetMaterial,WS-ReadChassisMaterial,WS-ReadKVMSwitchMaterial,WS-ReadNetworkMaterial,WS-ReadPDUMaterial,WS-ReadPeripheralMaterial,WS-ReadPowerStripMaterial,WS-ReadReceptacleMaterial,WS-ReadServerMaterial,WS-ReadStaticSwitchMaterial,WS-ReadUPSMaterial | integration/api/odata/Materials({key}) | |
Materials Actions
|
Action | Required Permission(s) | Link | Description |
---|
UploadFile | WS-AddFile | integration/api/odata/Materials({key})/UploadFile(File={file}) | |
DeleteFile | WS-ModifyFile | integration/api/odata/Materials({key})/DeleteFile(FileName={filename}) | |
Materials Functions
|
Function | Required Permission(s) | Link | Description |
---|
DownloadFile | WS-ReadFile | integration/api/odata/Materials({key})/DownloadFile(FileName={filename}) | |
Materials Custom Routes
|
CustomRoute | Required Permission(s) | Supported Method(s) | Description |
---|
integration/api/odata/Materials/In(Ids={ids}) | |
GET
| |
integration/api/odata/Materials/NotIn(Ids={ids}) | |
GET
| |
integration/api/odata/Materials({key})/Files | |
DELETE
| |
Materials Nested Properties
No nested properties
Verb(s) | Required Permission(s) | Link | Description |
---|
GET | WS-ReadAirConditioningMaterial,WS-ReadAuxiliaryMaterial,WS-ReadCabinetMaterial,WS-ReadChassisMaterial,WS-ReadKVMSwitchMaterial,WS-ReadNetworkMaterial,WS-ReadPDUMaterial,WS-ReadPeripheralMaterial,WS-ReadPowerStripMaterial,WS-ReadReceptacleMaterial,WS-ReadServerMaterial,WS-ReadStaticSwitchMaterial,WS-ReadUPSMaterial,WS-ReadSoftware | integration/api/odata/MaterialsAndSoftware | |
GET | WS-ReadAirConditioningMaterial,WS-ReadAuxiliaryMaterial,WS-ReadCabinetMaterial,WS-ReadChassisMaterial,WS-ReadKVMSwitchMaterial,WS-ReadNetworkMaterial,WS-ReadPDUMaterial,WS-ReadPeripheralMaterial,WS-ReadPowerStripMaterial,WS-ReadReceptacleMaterial,WS-ReadServerMaterial,WS-ReadStaticSwitchMaterial,WS-ReadUPSMaterial,WS-ReadSoftware | integration/api/odata/MaterialsAndSoftware({key}) | |
MaterialsAndSoftware Actions
No actions
MaterialsAndSoftware Functions
No functions
MaterialsAndSoftware Custom Routes
|
CustomRoute | Required Permission(s) | Supported Method(s) | Description |
---|
integration/api/odata/MaterialsAndSoftware/In(Ids={ids}) | |
GET
| |
integration/api/odata/MaterialsAndSoftware/NotIn(Ids={ids}) | |
GET
| |
MaterialsAndSoftware Nested Properties
No nested properties
Verb(s) | Required Permission(s) | Link | Description |
---|
GET | | integration/api/odata/MaterialSubtypes | |
GET | | integration/api/odata/MaterialSubtypes({key}) | |
MaterialSubtypes Actions
No actions
MaterialSubtypes Functions
No functions
MaterialSubtypes Custom Routes
|
CustomRoute | Required Permission(s) | Supported Method(s) | Description |
---|
integration/api/odata/MaterialSubtypes/In(Ids={ids}) | |
GET
| |
integration/api/odata/MaterialSubtypes/NotIn(Ids={ids}) | |
GET
| |
MaterialSubtypes Nested Properties
No nested properties
Verb(s) | Required Permission(s) | Link | Description |
---|
GET | | integration/api/odata/MaterialTypes | |
GET | | integration/api/odata/MaterialTypes({key}) | |
MaterialTypes Actions
No actions
MaterialTypes Functions
No functions
MaterialTypes Custom Routes
|
CustomRoute | Required Permission(s) | Supported Method(s) | Description |
---|
integration/api/odata/MaterialTypes/In(Ids={ids}) | |
GET
| |
integration/api/odata/MaterialTypes/NotIn(Ids={ids}) | |
GET
| |
MaterialTypes Nested Properties
No nested properties
Verb(s) | Required Permission(s) | Link | Description |
---|
POST | WS-AddNetworkMaterial | integration/api/odata/ModuleNetworkMaterials | |
PATCH | WS-ModifyNetworkMaterial | integration/api/odata/ModuleNetworkMaterials({key}) | |
DELETE | WS-ModifyNetworkMaterial | integration/api/odata/ModuleNetworkMaterials({key}) | |
GET | WS-ReadNetworkMaterial | integration/api/odata/ModuleNetworkMaterials | |
GET | WS-ReadNetworkMaterial | integration/api/odata/ModuleNetworkMaterials({key}) | |
ModuleNetworkMaterials Actions
|
Action | Required Permission(s) | Link | Description |
---|
Cancel | WS-ModifyNetworkMaterial | integration/api/odata/ModuleNetworkMaterials({key})/Cancel | |
Activate | WS-ModifyNetworkMaterial | integration/api/odata/ModuleNetworkMaterials({key})/Activate | Function that will move a material in Active status. |
Deactivate | WS-ModifyNetworkMaterial | integration/api/odata/ModuleNetworkMaterials({key})/Deactivate | Function that will move a material in Inactive status. |
UploadFile | WS-AddFile | integration/api/odata/ModuleNetworkMaterials({key})/UploadFile(File={file}) | |
DeleteFile | WS-ModifyFile | integration/api/odata/ModuleNetworkMaterials({key})/DeleteFile(FileName={filename}) | |
ModuleNetworkMaterials Functions
|
Function | Required Permission(s) | Link | Description |
---|
DownloadFile | WS-ReadFile | integration/api/odata/ModuleNetworkMaterials({key})/DownloadFile(FileName={filename}) | |
GetAuditLogData | WS-ReadAuditLog | integration/api/odata/ModuleNetworkMaterials({key})/GetAuditLogData | Function used to export all audit information for a specific entity. Please use the following Content-Type:application/vnd.openxmlformats-officedocument.spreadsheetml.sheet for file download |
ModuleNetworkMaterials Custom Routes
|
CustomRoute | Required Permission(s) | Supported Method(s) | Description |
---|
integration/api/odata/ModuleNetworkMaterials/In(Ids={ids}) | |
GET
| |
integration/api/odata/ModuleNetworkMaterials/NotIn(Ids={ids}) | |
GET
| |
integration/api/odata/ModuleNetworkMaterials({key})/Files | |
DELETE
| |
ModuleNetworkMaterials Nested Properties
No nested properties
Verb(s) | Required Permission(s) | Link | Description |
---|
POST | WS-ModifyPeripheralMaterial | integration/api/odata/MonitorPeripheralMaterials({key}) | |
POST | WS-AddPeripheralMaterial | integration/api/odata/MonitorPeripheralMaterials | |
PATCH | WS-ModifyPeripheralMaterial | integration/api/odata/MonitorPeripheralMaterials({key}) | |
DELETE | WS-ModifyPeripheralMaterial | integration/api/odata/MonitorPeripheralMaterials({key}) | |
GET | WS-ReadPeripheralMaterial | integration/api/odata/MonitorPeripheralMaterials | |
GET | WS-ReadPeripheralMaterial | integration/api/odata/MonitorPeripheralMaterials({key}) | |
MonitorPeripheralMaterials Actions
|
Action | Required Permission(s) | Link | Description |
---|
Cancel | WS-ModifyPeripheralMaterial | integration/api/odata/MonitorPeripheralMaterials({key})/Cancel | |
Activate | WS-ModifyPeripheralMaterial | integration/api/odata/MonitorPeripheralMaterials({key})/Activate | Function that will move a material in Active status. |
Deactivate | WS-ModifyPeripheralMaterial | integration/api/odata/MonitorPeripheralMaterials({key})/Deactivate | Function that will move a material in Inactive status. |
UploadFile | WS-AddFile | integration/api/odata/MonitorPeripheralMaterials({key})/UploadFile(File={file}) | |
DeleteFile | WS-ModifyFile | integration/api/odata/MonitorPeripheralMaterials({key})/DeleteFile(FileName={filename}) | |
MonitorPeripheralMaterials Functions
|
Function | Required Permission(s) | Link | Description |
---|
DownloadFile | WS-ReadFile | integration/api/odata/MonitorPeripheralMaterials({key})/DownloadFile(FileName={filename}) | |
GetAuditLogData | WS-ReadAuditLog | integration/api/odata/MonitorPeripheralMaterials({key})/GetAuditLogData | Function used to export all audit information for a specific entity. Please use the following Content-Type:application/vnd.openxmlformats-officedocument.spreadsheetml.sheet for file download |
MonitorPeripheralMaterials Custom Routes
|
CustomRoute | Required Permission(s) | Supported Method(s) | Description |
---|
integration/api/odata/MonitorPeripheralMaterials/In(Ids={ids}) | |
GET
| |
integration/api/odata/MonitorPeripheralMaterials/NotIn(Ids={ids}) | |
GET
| |
integration/api/odata/MonitorPeripheralMaterials({key})/Files | |
DELETE
| |
MonitorPeripheralMaterials Nested Properties
No nested properties
Verb(s) | Required Permission(s) | Link | Description |
---|
POST | WS-AddPeripheralMaterial | integration/api/odata/MousePeripheralMaterials | |
PATCH | WS-ModifyPeripheralMaterial | integration/api/odata/MousePeripheralMaterials({key}) | |
DELETE | WS-ModifyPeripheralMaterial | integration/api/odata/MousePeripheralMaterials({key}) | |
GET | WS-ReadPeripheralMaterial | integration/api/odata/MousePeripheralMaterials | |
GET | WS-ReadPeripheralMaterial | integration/api/odata/MousePeripheralMaterials({key}) | |
MousePeripheralMaterials Actions
|
Action | Required Permission(s) | Link | Description |
---|
Cancel | WS-ModifyPeripheralMaterial | integration/api/odata/MousePeripheralMaterials({key})/Cancel | |
Activate | WS-ModifyPeripheralMaterial | integration/api/odata/MousePeripheralMaterials({key})/Activate | Function that will move a material in Active status. |
Deactivate | WS-ModifyPeripheralMaterial | integration/api/odata/MousePeripheralMaterials({key})/Deactivate | Function that will move a material in Inactive status. |
UploadFile | WS-AddFile | integration/api/odata/MousePeripheralMaterials({key})/UploadFile(File={file}) | |
DeleteFile | WS-ModifyFile | integration/api/odata/MousePeripheralMaterials({key})/DeleteFile(FileName={filename}) | |
MousePeripheralMaterials Functions
|
Function | Required Permission(s) | Link | Description |
---|
DownloadFile | WS-ReadFile | integration/api/odata/MousePeripheralMaterials({key})/DownloadFile(FileName={filename}) | |
GetAuditLogData | WS-ReadAuditLog | integration/api/odata/MousePeripheralMaterials({key})/GetAuditLogData | Function used to export all audit information for a specific entity. Please use the following Content-Type:application/vnd.openxmlformats-officedocument.spreadsheetml.sheet for file download |
MousePeripheralMaterials Custom Routes
|
CustomRoute | Required Permission(s) | Supported Method(s) | Description |
---|
integration/api/odata/MousePeripheralMaterials/In(Ids={ids}) | |
GET
| |
integration/api/odata/MousePeripheralMaterials/NotIn(Ids={ids}) | |
GET
| |
integration/api/odata/MousePeripheralMaterials({key})/Files | |
DELETE
| |
MousePeripheralMaterials Nested Properties
No nested properties
Verb(s) | Required Permission(s) | Link | Description |
---|
GET | WS-ReadCabinet,WS-ReadServer,WS-ReadUPS,WS-ReadNetwork,WS-ReadPeripheral,WS-ReadStaticSwitch,WS-ReadReceptacle,WS-ReadKVMSwitch,WS-ReadAuxiliary,WS-ReadAirConditioning,WS-ReadChassis,WS-ReadPDU,WS-ReadPowerStrip,WS-ReadServerHost,WS-ReadNetworkMaterial,WS-ReadCabinetMaterial,WS-ReadPeripheralMaterial,WS-ReadKVMSwitchMaterial,WS-ReadServerMaterial,WS-ReadPDUMaterial,WS-ReadPowerStripMaterial,WS-ReadAirConditioningMaterial,WS-ReadReceptacleMaterial,WS-ReadChassisMaterial,WS-ReadUPSMaterial,WS-ReadAuxiliaryMaterial,WS-ReadStaticSwitchMaterial,WS-ReadCabinetMountedAssetMap,WS-ReadChassisMountedAssetMap | integration/api/odata/NavigatorAssets({key}) | |
GET | WS-ReadCabinet,WS-ReadServer,WS-ReadUPS,WS-ReadNetwork,WS-ReadPeripheral,WS-ReadStaticSwitch,WS-ReadReceptacle,WS-ReadKVMSwitch,WS-ReadAuxiliary,WS-ReadAirConditioning,WS-ReadChassis,WS-ReadPDU,WS-ReadPowerStrip,WS-ReadServerHost,WS-ReadNetworkMaterial,WS-ReadCabinetMaterial,WS-ReadPeripheralMaterial,WS-ReadKVMSwitchMaterial,WS-ReadServerMaterial,WS-ReadPDUMaterial,WS-ReadPowerStripMaterial,WS-ReadAirConditioningMaterial,WS-ReadReceptacleMaterial,WS-ReadChassisMaterial,WS-ReadUPSMaterial,WS-ReadAuxiliaryMaterial,WS-ReadStaticSwitchMaterial,WS-ReadCabinetMountedAssetMap,WS-ReadChassisMountedAssetMap | integration/api/odata/NavigatorAssets | |
NavigatorAssets Actions
No actions
NavigatorAssets Functions
No functions
NavigatorAssets Custom Routes
|
CustomRoute | Required Permission(s) | Supported Method(s) | Description |
---|
integration/api/odata/NavigatorAssets/ByType(Ids={ids}, MaterialTypeID={materialTypeId}, IncludeChildren={includeChildren}) | |
GET
| |
NavigatorAssets Nested Properties
No nested properties
Verb(s) | Required Permission(s) | Link | Description |
---|
POST | | integration/api/odata/NetworkCableTypes | |
DELETE | | integration/api/odata/NetworkCableTypes({key}) | |
PATCH | | integration/api/odata/NetworkCableTypes({key}) | |
GET | | integration/api/odata/NetworkCableTypes | |
GET | | integration/api/odata/NetworkCableTypes({key}) | |
NetworkCableTypes Actions
No actions
NetworkCableTypes Functions
No functions
NetworkCableTypes Custom Routes
No custom routes
NetworkCableTypes Nested Properties
No nested properties
Verb(s) | Required Permission(s) | Link | Description |
---|
GET | | integration/api/odata/NetworkCardPortNames | |
GET | | integration/api/odata/NetworkCardPortNames({key}) | |
NetworkCardPortNames Actions
No actions
NetworkCardPortNames Functions
No functions
NetworkCardPortNames Custom Routes
|
CustomRoute | Required Permission(s) | Supported Method(s) | Description |
---|
integration/api/odata/NetworkCardPortNames/In(Ids={ids}) | |
GET
| |
integration/api/odata/NetworkCardPortNames/NotIn(Ids={ids}) | |
GET
| |
NetworkCardPortNames Nested Properties
No nested properties
Verb(s) | Required Permission(s) | Link | Description |
---|
POST | WS-ModifyNetworkConnection | integration/api/odata/NetworkGraphs({key}) | |
POST | WS-AddNetworkConnection | integration/api/odata/NetworkGraphs | |
GET | WS-ReadNetworkConnection | integration/api/odata/NetworkGraphs | |
GET | WS-ReadNetworkConnection | integration/api/odata/NetworkGraphs({key}) | |
NetworkGraphs Actions
No actions
NetworkGraphs Functions
No functions
NetworkGraphs Custom Routes
|
CustomRoute | Required Permission(s) | Supported Method(s) | Description |
---|
integration/api/odata/NetworkGraphs/In(Ids={ids}) | |
GET
| |
integration/api/odata/NetworkGraphs/NotIn(Ids={ids}) | |
GET
| |
integration/api/odata/SetGroupTrunkName | WS-ModifyNetworkConnection |
POST
| |
NetworkGraphs Nested Properties
|
NestedProperty | Supported Method(s) |
---|
PortStartNode |
PATCH
|
PortEndNode |
PATCH
|
Verb(s) | Required Permission(s) | Link | Description |
---|
POST | WS-ModifyNetworkMaterial | integration/api/odata/NetworkMaterials({key}) | |
POST | WS-AddNetworkMaterial | integration/api/odata/NetworkMaterials | |
PATCH | WS-ModifyNetworkMaterial | integration/api/odata/NetworkMaterials({key}) | |
DELETE | WS-ModifyNetworkMaterial | integration/api/odata/NetworkMaterials({key}) | |
GET | WS-ReadNetworkMaterial | integration/api/odata/NetworkMaterials | |
GET | WS-ReadNetworkMaterial | integration/api/odata/NetworkMaterials({key}) | |
NetworkMaterials Actions
|
Action | Required Permission(s) | Link | Description |
---|
Cancel | WS-ModifyNetworkMaterial | integration/api/odata/NetworkMaterials({key})/Cancel | |
Activate | WS-ModifyNetworkMaterial | integration/api/odata/NetworkMaterials({key})/Activate | Function that will move a material in Active status. |
Deactivate | WS-ModifyNetworkMaterial | integration/api/odata/NetworkMaterials({key})/Deactivate | Function that will move a material in Inactive status. |
DeleteMaterialPortGroupMaps | WS-ModifyNetworkMaterial | integration/api/odata/NetworkMaterials({key})/DeleteMaterialPortGroupMaps(NetworkMaterialPortGroupMapIDs={networkmaterialportgroupmapids}) | |
UploadFile | WS-AddFile | integration/api/odata/NetworkMaterials({key})/UploadFile(File={file}) | |
DeleteFile | WS-ModifyFile | integration/api/odata/NetworkMaterials({key})/DeleteFile(FileName={filename}) | |
NetworkMaterials Functions
|
Function | Required Permission(s) | Link | Description |
---|
SearchNetworkByMaterialPorts | WS-ReadNetwork | integration/api/odata/NetworkMaterials({key})/SearchNetworkByMaterialPorts | |
DownloadFile | WS-ReadFile | integration/api/odata/NetworkMaterials({key})/DownloadFile(FileName={filename}) | |
GetAuditLogData | WS-ReadAuditLog | integration/api/odata/NetworkMaterials({key})/GetAuditLogData | Function used to export all audit information for a specific entity. Please use the following Content-Type:application/vnd.openxmlformats-officedocument.spreadsheetml.sheet for file download |
NetworkMaterials Custom Routes
|
CustomRoute | Required Permission(s) | Supported Method(s) | Description |
---|
integration/api/odata/PanelNetworkMaterials({key}) | |
POST
| |
integration/api/odata/CardNetworkMaterials({key}) | |
POST
| |
integration/api/odata/ModuleNetworkMaterials({key}) | |
POST
| |
integration/api/odata/NetworkMaterials/In(Ids={ids}) | |
GET
| |
integration/api/odata/NetworkMaterials/NotIn(Ids={ids}) | |
GET
| |
integration/api/odata/NetworkMaterials({key})/Files | |
DELETE
| |
NetworkMaterials Nested Properties
No nested properties
Verb(s) | Required Permission(s) | Link | Description |
---|
PATCH | WS-ModifyNetworkConnection | integration/api/odata/NetworkPortGroups({key}) | |
POST | WS-ModifyNetworkConnection | integration/api/odata/NetworkPortGroups({key}) | |
GET | WS-ReadNetworkConnection | integration/api/odata/NetworkPortGroups | |
GET | WS-ReadNetworkConnection | integration/api/odata/NetworkPortGroups({key}) | |
NetworkPortGroups Actions
No actions
NetworkPortGroups Functions
No functions
NetworkPortGroups Custom Routes
|
CustomRoute | Required Permission(s) | Supported Method(s) | Description |
---|
integration/api/odata/NetworkPortGroups({key})/NetworkPortGroupAssetIPAddressMaps | |
DELETE
| |
NetworkPortGroups Nested Properties
No nested properties
Verb(s) | Required Permission(s) | Link | Description |
---|
GET | WS-ReadNetworkConnection | integration/api/odata/NetworkPortGroupTypes | |
GET | WS-ReadNetworkConnection | integration/api/odata/NetworkPortGroupTypes({key}) | |
NetworkPortGroupTypes Actions
No actions
NetworkPortGroupTypes Functions
No functions
NetworkPortGroupTypes Custom Routes
No custom routes
NetworkPortGroupTypes Nested Properties
No nested properties
Verb(s) | Required Permission(s) | Link | Description |
---|
GET | WS-ReadNetworkConnection | integration/api/odata/NetworkPorts | |
GET | WS-ReadNetworkConnection | integration/api/odata/NetworkPorts({key}) | |
NetworkPorts Actions
|
Action | Required Permission(s) | Link | Description |
---|
GetPortConnectionTraceForExport | WS-ReadNetworkConnection | integration/api/odata/NetworkPorts({key})/GetPortConnectionTraceForExport | |
NetworkPorts Functions
|
Function | Required Permission(s) | Link | Description |
---|
GetPortConnectionTrace | WS-ReadNetworkConnection | integration/api/odata/NetworkPorts({key})/GetPortConnectionTrace | |
GetTraceLinks | WS-ReadNetworkConnection | integration/api/odata/NetworkPorts({key})/GetTraceLinks | |
NetworkPorts Custom Routes
|
CustomRoute | Required Permission(s) | Supported Method(s) | Description |
---|
integration/api/odata/NetworkPorts({key})/NetworkPortAssetIPAddressMaps({relatedKey}) | |
DELETE
| |
integration/api/odata/NetworkPorts({key})/NetworkPortServerHostIPAddressMaps({relatedKey}) | |
DELETE
| |
integration/api/odata/NetworkPorts({key})/Notes({relatedKey}) | |
GET
| |
integration/api/odata/NetworkPorts({key})/Notes | |
GET
| |
integration/api/odata/NetworkPorts({key})/Notes | |
POST
| |
integration/api/odata/NetworkPorts({key})/Notes | |
DELETE
| |
integration/api/odata/NetworkPorts({key})/Notes({relatedKey}) | |
DELETE
| |
integration/api/odata/NetworkPorts({key})/Notes({relatedKey}) | |
PATCH
| |
integration/api/odata/NetworkPorts({key})/ServiceProvider | WS-ModifyNetworkConnection |
PATCH
| |
integration/api/odata/NetworkPorts/In(Ids={ids}) | |
GET
| |
integration/api/odata/NetworkPorts/NotIn(Ids={ids}) | |
GET
| |
NetworkPorts Nested Properties
|
NestedProperty | Supported Method(s) |
---|
NetworkPortAssetIPAddressMaps |
POST
|
NetworkPortServerHostIPAddressMaps |
POST
|
Verb(s) | Required Permission(s) | Link | Description |
---|
POST | WS-AddNetwork | integration/api/odata/Networks | |
DELETE | WS-ModifyNetwork | integration/api/odata/Networks({key}) | |
PATCH | WS-ModifyNetwork | integration/api/odata/Networks({key}) | |
POST | WS-ModifyNetwork | integration/api/odata/Networks({key}) | |
GET | WS-ReadNetwork | integration/api/odata/Networks | |
GET | WS-ReadNetwork | integration/api/odata/Networks({key}) | |
Networks Actions
|
Action | Required Permission(s) | Link | Description |
---|
BeginMove | WS-PlanMoveNetwork, WS-PlanRecycleNetwork, WS-PlanDecommissionNetwork | integration/api/odata/Networks({key})/BeginMove(RelocateType={relocatetype}) | Function that is used to move the selected asset in a planned state, Moving, Recycling or Decommissioning, depending on the RelocateType provided as parameter. The response contains the Planned AssetId. |
CancelMove | WS-CancelMoveNetwork, WS-CancelRecycleNetwork, WS-CancelDecommissionNetwork | integration/api/odata/Networks({key})/CancelMove | Function that is used to cancel planned action. The selected asset will become Active/Operational. |
CompleteMove | WS-CompleteMoveNetwork, WS-CompleteRecycleNetwork, WS-CompleteDecommissionNetwork | integration/api/odata/Networks({key})/CompleteMove | Function that is used to finish planned action. The selected asset will become Active/Operational, Recycled/Available or Decommissioned/Decommissioned, depending on the Planned entity type (Move, Recycle or Deccommission). |
DirectMove | WS-SetLocationNetwork | integration/api/odata/Networks({key})/DirectMove(RelocateType={relocatetype}, LocationGroupID={locationgroupid}) | Function that is used to directly move an asset to a new location in a final state. |
CompleteCreation | WS-ModifyNetwork | integration/api/odata/Networks({key})/CompleteCreation | Function that moves an asset from Planned/(Pre)Procurement to Active/Operational. |
SetMaterial | | integration/api/odata/Networks({key})/SetMaterial(NewMaterialID={newmaterialid}) | Function that is used to change the material on an existing asset. This action is only supported for Receptacles and Power Strips. |
AddRealTimeValues | WS-AddAssetRealtimeData | integration/api/odata/Networks({key})/AddRealTimeValues(RealTimeInfo={realtimeinfo}, RealTimeValue={realtimevalue}) | Adds a provider specfic recorded real-time value against an asset or its associated outlet. Custom metrics are only allowed on assets whereas load, power and voltage metrics are allowed against assets, outlets or their relevant phases. |
AddNetworkAsset | WS-ReadNetworkConnection,WS-AddNetworkConnection | integration/api/odata/Networks({key})/AddNetworkAsset(NetworkAssetId={networkassetid}) | Function that is adding the selected asset in the list of available asset to be used in network connections. The mapping between the two assets is created by providing the NetworkAssetId parameter in the BODY, NetworkAssetId representing the AssetID of the asset to be added in the list of available assets. |
RemoveNetworkAsset | WS-ModifyNetworkConnection | integration/api/odata/Networks({key})/RemoveNetworkAsset(NetworkAssetId={networkassetid}, NetworkLinkerType={networklinkertype}) | Function that removes an asset from the association list of available asset to be used in network connections. |
UploadFile | WS-AddFile | integration/api/odata/Networks({key})/UploadFile(File={file}) | |
DeleteFile | WS-ModifyFile | integration/api/odata/Networks({key})/DeleteFile(FileName={filename}) | |
Networks Functions
|
Function | Required Permission(s) | Link | Description |
---|
ListLinkedRecords | | integration/api/odata/Networks/ListLinkedRecords(assetIds={assetids}) | Retrieves a collection of assets, associated to the selected asset that will be affected by a potential move action. |
GetCablePortConnections | WS-ReadNetworkConnection | integration/api/odata/Networks({key})/GetCablePortConnections | Returns a collection of port connections for cable, entity type used is Nlyte.Model.NetworkResult |
GetPatchPortConnections | WS-ReadNetworkConnection | integration/api/odata/Networks({key})/GetPatchPortConnections | Returns a collection of port connections for patch, entity type used is Nlyte.Model.NetworkResult |
GetTotalSystemPowerConsumption | WS-ReadNetwork | integration/api/odata/Networks({key})/GetTotalSystemPowerConsumption | Function that returns the TotalSystemPowerConsumption for the selected asset. |
GetRealTimePowerInfo | WS-ReadNetwork | integration/api/odata/Networks({key})/GetRealTimePowerInfo | |
GetDiscoveryAssetPage | WS-ReadNetwork | integration/api/odata/Networks({key})/GetDiscoveryAssetPage | Function that returns a collection of entities of type Nlyte.Model.AssetMapping. Used to determine external providers. |
RecordModifiedInfo | WS-ReadNetwork | integration/api/odata/Networks({key})/RecordModifiedInfo | Function that returns an entity of type Nlyte.Model.AuditLogInfo and provides information regarding last modifications against the current asset |
GetChassisWithFreeSlots | WS-ReadChassis | integration/api/odata/Networks({key})/GetChassisWithFreeSlots(SearchTerm={searchterm}, SearchTermOption={searchtermoption}, OrientationID={orientationid}) | Returns a collection of entities of type Nlyte.Model.ChassisWithFreeSlots representing chassis assets with free slots available. |
GetMountedChildAssets | | integration/api/odata/Networks({key})/GetMountedChildAssets(IncludeHosts={includehosts}, IncludeCards={includecards}) | Function that returns a collection of entities of type Nlyte.Model.MountedAssetSummary representing the list of mounted assets in the provided asset. The function is called as follows: Assets(AssetID)/GetMountedChildAssets(IncludeHosts=true,IncludeCards=true) where AssetID is the parent for which the children are retrieved. |
GetDistributorsWithFreeOutlets | WS-ReadAssetToAssetMapping | integration/api/odata/Networks({key})/GetDistributorsWithFreeOutlets(SearchTerm={searchterm}, SearchTermOption={searchtermoption}, LocationDepth={locationdepth}, MaterialTypeID={materialtypeid}, MaterialSubtypeID={materialsubtypeid}) | Function that returns a collection of entities of type Nlyte.Model.Distributor representing available power suppliers. |
SearchAssetNetworkPortLinkage | WS-ReadNetworkConnection | integration/api/odata/Networks({key})/SearchAssetNetworkPortLinkage(SearchTerm={searchterm}, SearchTermOption={searchtermoption}, CabinetMountingStatus={cabinetmountingstatus}, LocationTarget={locationtarget}, NetworkTypes={networktypes}, PortLocation={portlocation}) | Function that returns a collection of entities of type Nlyte.Model.AssetNetworkPortLinkage representing available assets to be used in network connections. |
GetRealTimeValues | WS-ReadAssetRealtimeData | integration/api/odata/Networks({key})/GetRealTimeValues | Function that returns a collection of entities of type Nlyte.Model.RealTimeValue. |
GetAssetSummaries | | integration/api/odata/Networks({key})/GetAssetSummaries(OwnedPeripherals={ownedperipherals}, IncludeHosts={includehosts}) | |
GetNetworkCardPortsInfo | WS-ReadNetworkConnection | integration/api/odata/Networks({key})/GetNetworkCardPortsInfo | Returns an object of type Nlyte.Model.NetworkResults having information about Copper and Fiber Ports |
GetNetworkCardPortConnections | WS-ReadNetworkConnection | integration/api/odata/Networks({key})/GetNetworkCardPortConnections | Returns an object of type Nlyte.Model.NetworkResults having information about Copper and Fiber Port connections |
GetNetworkAssetSummary | WS-ReadNetworkConnection | integration/api/odata/Networks({key})/GetNetworkAssetSummary | Returns an object of type Nlyte.Model.NetworkResults having information about the networkable assets. |
ListPowerConsumers | | integration/api/odata/Networks({key})/ListPowerConsumers | Function that returns a collection of Nlyte.Model.Graph entities. Used to identify available Output Connector used in power connections. |
SupportsPlannedMove | | integration/api/odata/Networks({key})/SupportsPlannedMove | |
GetTotalSystemWeight | | integration/api/odata/Networks({key})/GetTotalSystemWeight | Function that returns the TotalSystemWeight for the selected asset. |
GetMountedOnAssetID | | integration/api/odata/Networks({key})/GetMountedOnAssetID | |
GetAssetsReportData | WS-ReadNetwork,WS-ReadCabinet,WS-ReadPeripheral,WS-ReadKVMSwitch,WS-ReadServer,WS-ReadPDU,WS-ReadPowerStrip,WS-ReadAirConditioning,WS-ReadReceptacle,WS-ReadChassis,WS-ReadUPS,WS-ReadAuxiliary,WS-ReadStaticSwitch,WS-ReadServerHost | integration/api/odata/Networks/GetAssetsReportData(assetIds={assetids}) | |
DownloadFile | WS-ReadFile | integration/api/odata/Networks({key})/DownloadFile(FileName={filename}) | |
GetAuditLogData | WS-ReadAuditLog | integration/api/odata/Networks({key})/GetAuditLogData | Function used to export all audit information for a specific entity. Please use the following Content-Type:application/vnd.openxmlformats-officedocument.spreadsheetml.sheet for file download |
Networks Custom Routes
|
CustomRoute | Required Permission(s) | Supported Method(s) | Description |
---|
integration/api/odata/Networks({key})/Notes({relatedKey}) | |
GET
| |
integration/api/odata/Networks({key})/Notes | |
GET
| |
integration/api/odata/Networks({key})/Notes | |
POST
| |
integration/api/odata/Networks({key})/Notes | |
DELETE
| |
integration/api/odata/Networks({key})/Notes({relatedKey}) | |
DELETE
| |
integration/api/odata/Networks({key})/Notes({relatedKey}) | |
PATCH
| |
integration/api/odata/Networks({key})/Peripherals({relatedKey})/Notes({nestedRelatedKey}) | |
GET
| |
integration/api/odata/Networks({key})/Peripherals({relatedKey})/Notes | |
GET
| |
integration/api/odata/Networks({key})/Peripherals({relatedKey})/Notes({nestedRelatedKey}) | |
PATCH
| |
integration/api/odata/Networks({key})/Peripherals({relatedKey})/Notes | |
POST
| |
integration/api/odata/Networks({key})/Peripherals({relatedKey})/Notes | |
DELETE
| |
integration/api/odata/Networks({key})/Peripherals({relatedKey})/Notes({nestedRelatedKey}) | |
DELETE
| |
integration/api/odata/Networks({key})/AssociatedAssets({relatedKey}) | |
DELETE
| |
integration/api/odata/Networks({key})/AssociatedAssets({relatedKey})/Notes({nestedRelatedKey}) | |
GET
| |
integration/api/odata/Networks({key})/AssociatedAssets({relatedKey})/Notes | |
GET
| |
integration/api/odata/Networks({key})/AssociatedAssets({relatedKey})/Notes({nestedRelatedKey}) | |
PATCH
| |
integration/api/odata/Networks({key})/AssociatedAssets({relatedKey})/Notes | |
POST
| |
integration/api/odata/Networks({key})/Graphs | |
GET
| |
integration/api/odata/Networks({key})/Graphs({relatedKey}) | |
GET
| |
integration/api/odata/Networks({key})/Graphs({relatedKey}) | |
PATCH
| |
integration/api/odata/Networks({key})/Graphs | |
POST
| |
integration/api/odata/Networks({key})/Graphs({relatedKey}) | |
DELETE
| |
integration/api/odata/Networks({key})/NetworkPorts | |
GET
| |
integration/api/odata/Networks({key})/NetworkPorts({relatedKey}) | |
PATCH
| |
integration/api/odata/Networks({key})/GetAvailableCabinetUs(CabinetID={cabinetId}) | WS-ReadCabinet |
GET
| |
integration/api/odata/Networks({key})/Peripherals | |
POST
| |
integration/api/odata/Networks({key})/Peripherals({relatedKey}) | |
DELETE
| |
integration/api/odata/Networks({key})/GetServiceRequests | |
GET
| |
integration/api/odata/Networks({key})/CustomFields | WS-ReadCustomFieldNetwork |
GET
| |
integration/api/odata/Networks({key})/CustomFields | WS-ModifyCustomFieldNetwork |
POST
| |
integration/api/odata/Networks({key})/CustomFields({relatedKey}) | WS-ModifyCustomFieldNetwork |
PATCH
| |
integration/api/odata/Networks({key})/CustomFields({relatedKey}) | WS-ModifyCustomFieldNetwork |
DELETE
| |
integration/api/odata/Networks({key})/Warranty | WS-ReadNetwork |
GET
| |
integration/api/odata/Networks({key})/Warranty | WS-ModifyNetwork |
POST
| |
integration/api/odata/Networks({key})/Warranty | WS-ModifyNetwork |
PATCH
| |
integration/api/odata/Networks({key})/Warranty | WS-ModifyNetwork |
DELETE
| |
integration/api/odata/Networks({key})/Maintenance | WS-ReadNetwork |
GET
| |
integration/api/odata/Networks({key})/Maintenance | WS-ModifyNetwork |
POST
| |
integration/api/odata/Networks({key})/Maintenance | WS-ModifyNetwork |
PATCH
| |
integration/api/odata/Networks({key})/Maintenance | WS-ModifyNetwork |
DELETE
| |
integration/api/odata/Networks({key})/AssetMounting | |
GET
| |
integration/api/odata/Networks({key})/Ownership | WS-ReadBusinessGroupAssetMap |
GET
| |
integration/api/odata/Networks({key})/Ownership({relatedKey}) | WS-ReadBusinessGroupAssetMap |
GET
| |
integration/api/odata/Networks({key})/Ownership | WS-AddBusinessGroupAssetMap |
POST
| |
integration/api/odata/Networks({key})/Ownership({relatedKey}) | WS-ModifyBusinessGroupAssetMap |
PATCH
| |
integration/api/odata/Networks({key})/Ownership({relatedKey}) | WS-ModifyBusinessGroupAssetMap |
DELETE
| |
integration/api/odata/Networks({key})/Support | WS-ReadSupportGroupAssetMap |
GET
| |
integration/api/odata/Networks({key})/Support({relatedKey}) | WS-ReadSupportGroupAssetMap |
GET
| |
integration/api/odata/Networks({key})/Support | WS-AddSupportGroupAssetMap |
POST
| |
integration/api/odata/Networks({key})/Support({relatedKey}) | WS-ModifySupportGroupAssetMap |
PATCH
| |
integration/api/odata/Networks({key})/Support({relatedKey}) | WS-ModifySupportGroupAssetMap |
DELETE
| |
integration/api/odata/Networks/In(Ids={ids}) | |
GET
| |
integration/api/odata/Networks/NotIn(Ids={ids}) | |
GET
| |
integration/api/odata/Networks({key})/Files | |
DELETE
| |
integration/api/odata/BulkUpdateNetworkPortNames | WS-ModifyNetworkConnection |
POST
| |
Networks Nested Properties
|
NestedProperty | Supported Method(s) |
---|
Ownership |
BIND
POST
PATCH
|
Support |
BIND
POST
PATCH
|
CustomFields |
POST
PATCH
|
Maintenance |
POST
PATCH
|
Warranty |
POST
PATCH
|
AssetIPAddressMap |
POST
PATCH
|
LocationGroup | |
AssociatedAssets |
BIND
|
Peripherals |
BIND
POST
PATCH
|
InputConnectors |
PATCH
|
NetworkPorts |
PATCH
|
Graphs |
POST
PATCH
|
UMounting |
POST
PATCH
|
ChassisMountedAssetMap |
POST
PATCH
|
Verb(s) | Required Permission(s) | Link | Description |
---|
GET | WS-ReadOutputConnectorRealtimeData | integration/api/odata/OutputConnectorRealTimeData | |
GET | WS-ReadOutputConnectorRealtimeData | integration/api/odata/OutputConnectorRealTimeData({key}) | |
OutputConnectorRealTimeData Actions
No actions
OutputConnectorRealTimeData Functions
No functions
OutputConnectorRealTimeData Custom Routes
|
CustomRoute | Required Permission(s) | Supported Method(s) | Description |
---|
integration/api/odata/Cultures/In(Ids={ids}) | |
GET
| |
integration/api/odata/Cultures/NotIn(Ids={ids}) | |
GET
| |
OutputConnectorRealTimeData Nested Properties
No nested properties
Verb(s) | Required Permission(s) | Link | Description |
---|
GET | WS-ReadOutputConnectorRealtimePhaseData | integration/api/odata/OutputConnectorRealTimePhaseData | |
GET | WS-ReadOutputConnectorRealtimePhaseData | integration/api/odata/OutputConnectorRealTimePhaseData({key}) | |
OutputConnectorRealTimePhaseData Actions
No actions
OutputConnectorRealTimePhaseData Functions
No functions
OutputConnectorRealTimePhaseData Custom Routes
|
CustomRoute | Required Permission(s) | Supported Method(s) | Description |
---|
integration/api/odata/Cultures/In(Ids={ids}) | |
GET
| |
integration/api/odata/Cultures/NotIn(Ids={ids}) | |
GET
| |
OutputConnectorRealTimePhaseData Nested Properties
No nested properties
Verb(s) | Required Permission(s) | Link | Description |
---|
Overlays Actions
No actions
Overlays Functions
|
Function | Required Permission(s) | Link | Description |
---|
GetColourSchemes | | integration/api/odata/Overlays/GetColourSchemes | |
GetBusinessCriticalityLegend | | integration/api/odata/Overlays/GetBusinessCriticalityLegend | |
GetFloorPlannerReportLegend | | integration/api/odata/Overlays/GetFloorPlannerReportLegend(reportId={reportid}) | |
GetCabinetPlannerReportLegend | | integration/api/odata/Overlays/GetCabinetPlannerReportLegend(reportId={reportid}) | |
GetFloorPlannerReportCodes | | integration/api/odata/Overlays/GetFloorPlannerReportCodes | |
GetFloorPlannerCurrentReportCodes | | integration/api/odata/Overlays/GetFloorPlannerCurrentReportCodes | |
GetFloorPlannerPlannedReportCodes | | integration/api/odata/Overlays/GetFloorPlannerPlannedReportCodes | |
GetFloorPlannerReport | WS-ReadRoomPlan | integration/api/odata/Overlays/GetFloorPlannerReport(reportId={reportid}, locationGroupId={locationgroupid}, schemeId={schemeid}) | |
GetFloorPlannerReportForExport | WS-ReadRoomPlan | integration/api/odata/Overlays/GetFloorPlannerReportForExport(reportId={reportid}, locationGroupId={locationgroupid}) | |
GetCabinetPlannerReport | | integration/api/odata/Overlays/GetCabinetPlannerReport(reportId={reportid}, cabinetIds={cabinetids}, schemeId={schemeid}) | |
GetCabinetPlannerReportCodes | | integration/api/odata/Overlays/GetCabinetPlannerReportCodes | |
GetCabinetPlannerReportForExport | | integration/api/odata/Overlays/GetCabinetPlannerReportForExport(reportId={reportid}, cabinetIds={cabinetids}) | |
Overlays Custom Routes
No custom routes
Overlays Nested Properties
No nested properties
Verb(s) | Required Permission(s) | Link | Description |
---|
POST | WS-AddNetworkMaterial | integration/api/odata/PanelNetworkMaterials | |
PATCH | WS-ModifyNetworkMaterial | integration/api/odata/PanelNetworkMaterials({key}) | |
DELETE | WS-ModifyNetworkMaterial | integration/api/odata/PanelNetworkMaterials({key}) | |
GET | WS-ReadNetworkMaterial | integration/api/odata/PanelNetworkMaterials | |
GET | WS-ReadNetworkMaterial | integration/api/odata/PanelNetworkMaterials({key}) | |
PanelNetworkMaterials Actions
|
Action | Required Permission(s) | Link | Description |
---|
Cancel | WS-ModifyNetworkMaterial | integration/api/odata/PanelNetworkMaterials({key})/Cancel | |
Activate | WS-ModifyNetworkMaterial | integration/api/odata/PanelNetworkMaterials({key})/Activate | Function that will move a material in Active status. |
Deactivate | WS-ModifyNetworkMaterial | integration/api/odata/PanelNetworkMaterials({key})/Deactivate | Function that will move a material in Inactive status. |
UploadFile | WS-AddFile | integration/api/odata/PanelNetworkMaterials({key})/UploadFile(File={file}) | |
DeleteFile | WS-ModifyFile | integration/api/odata/PanelNetworkMaterials({key})/DeleteFile(FileName={filename}) | |
PanelNetworkMaterials Functions
|
Function | Required Permission(s) | Link | Description |
---|
DownloadFile | WS-ReadFile | integration/api/odata/PanelNetworkMaterials({key})/DownloadFile(FileName={filename}) | |
GetAuditLogData | WS-ReadAuditLog | integration/api/odata/PanelNetworkMaterials({key})/GetAuditLogData | Function used to export all audit information for a specific entity. Please use the following Content-Type:application/vnd.openxmlformats-officedocument.spreadsheetml.sheet for file download |
PanelNetworkMaterials Custom Routes
|
CustomRoute | Required Permission(s) | Supported Method(s) | Description |
---|
integration/api/odata/PanelNetworkMaterials/In(Ids={ids}) | |
GET
| |
integration/api/odata/PanelNetworkMaterials/NotIn(Ids={ids}) | |
GET
| |
integration/api/odata/PanelNetworkMaterials({key})/Files | |
DELETE
| |
PanelNetworkMaterials Nested Properties
No nested properties
Verb(s) | Required Permission(s) | Link | Description |
---|
POST | WS-AddPDUMaterial | integration/api/odata/PDUMaterials | |
PATCH | WS-ModifyPDUMaterial | integration/api/odata/PDUMaterials({key}) | |
DELETE | WS-ModifyPDUMaterial | integration/api/odata/PDUMaterials({key}) | |
GET | WS-ReadPDUMaterial | integration/api/odata/PDUMaterials | |
GET | WS-ReadPDUMaterial | integration/api/odata/PDUMaterials({key}) | |
PDUMaterials Actions
|
Action | Required Permission(s) | Link | Description |
---|
Cancel | WS-ModifyPDUMaterial | integration/api/odata/PDUMaterials({key})/Cancel | |
Activate | WS-ModifyPDUMaterial | integration/api/odata/PDUMaterials({key})/Activate | Function that will move a material in Active status. |
Deactivate | WS-ModifyPDUMaterial | integration/api/odata/PDUMaterials({key})/Deactivate | Function that will move a material in Inactive status. |
UploadFile | WS-AddFile | integration/api/odata/PDUMaterials({key})/UploadFile(File={file}) | |
DeleteFile | WS-ModifyFile | integration/api/odata/PDUMaterials({key})/DeleteFile(FileName={filename}) | |
PDUMaterials Functions
|
Function | Required Permission(s) | Link | Description |
---|
DownloadFile | WS-ReadFile | integration/api/odata/PDUMaterials({key})/DownloadFile(FileName={filename}) | |
GetAuditLogData | WS-ReadAuditLog | integration/api/odata/PDUMaterials({key})/GetAuditLogData | Function used to export all audit information for a specific entity. Please use the following Content-Type:application/vnd.openxmlformats-officedocument.spreadsheetml.sheet for file download |
PDUMaterials Custom Routes
|
CustomRoute | Required Permission(s) | Supported Method(s) | Description |
---|
integration/api/odata/PDUMaterials/In(Ids={ids}) | |
GET
| |
integration/api/odata/PDUMaterials/NotIn(Ids={ids}) | |
GET
| |
integration/api/odata/PDUMaterials({key})/Files | |
DELETE
| |
PDUMaterials Nested Properties
No nested properties
Verb(s) | Required Permission(s) | Link | Description |
---|
POST | WS-ModifyPDU | integration/api/odata/PDUs({key}) | |
POST | WS-AddPDU | integration/api/odata/PDUs | |
PATCH | WS-ModifyPDU | integration/api/odata/PDUs({key}) | |
DELETE | WS-ModifyPDU | integration/api/odata/PDUs({key}) | |
GET | WS-ReadPDU | integration/api/odata/PDUs | |
GET | WS-ReadPDU | integration/api/odata/PDUs({key}) | |
PDUs Actions
|
Action | Required Permission(s) | Link | Description |
---|
BeginMove | WS-PlanRecyclePDU, WS-PlanDecommissionPDU | integration/api/odata/PDUs({key})/BeginMove(RelocateType={relocatetype}) | Function that is used to move the selected asset in a planned state, Moving, Recycling or Decommissioning, depending on the RelocateType provided as parameter. The response contains the Planned AssetId. |
CancelMove | WS-CancelRecyclePDU, WS-CancelDecommissionPDU | integration/api/odata/PDUs({key})/CancelMove | Function that is used to cancel planned action. The selected asset will become Active/Operational. |
CompleteMove | WS-CompleteRecyclePDU, WS-CompleteDecommissionPDU | integration/api/odata/PDUs({key})/CompleteMove | Function that is used to finish planned action. The selected asset will become Active/Operational, Recycled/Available or Decommissioned/Decommissioned, depending on the Planned entity type (Move, Recycle or Deccommission). |
DirectMove | WS-SetLocationPDU | integration/api/odata/PDUs({key})/DirectMove(RelocateType={relocatetype}, LocationGroupID={locationgroupid}) | Function that is used to directly move an asset to a new location in a final state. |
CompleteCreation | WS-ModifyPDU | integration/api/odata/PDUs({key})/CompleteCreation | Function that moves an asset from Planned/(Pre)Procurement to Active/Operational. |
SetMaterial | | integration/api/odata/PDUs({key})/SetMaterial(NewMaterialID={newmaterialid}) | Function that is used to change the material on an existing asset. This action is only supported for Receptacles and Power Strips. |
AddRealTimeValues | WS-AddAssetRealtimeData | integration/api/odata/PDUs({key})/AddRealTimeValues(RealTimeInfo={realtimeinfo}, RealTimeValue={realtimevalue}) | Adds a provider specfic recorded real-time value against an asset or its associated outlet. Custom metrics are only allowed on assets whereas load, power and voltage metrics are allowed against assets, outlets or their relevant phases. |
AddNetworkAsset | WS-ReadNetworkConnection,WS-AddNetworkConnection | integration/api/odata/PDUs({key})/AddNetworkAsset(NetworkAssetId={networkassetid}) | Function that is adding the selected asset in the list of available asset to be used in network connections. The mapping between the two assets is created by providing the NetworkAssetId parameter in the BODY, NetworkAssetId representing the AssetID of the asset to be added in the list of available assets. |
RemoveNetworkAsset | WS-ModifyNetworkConnection | integration/api/odata/PDUs({key})/RemoveNetworkAsset(NetworkAssetId={networkassetid}, NetworkLinkerType={networklinkertype}) | Function that removes an asset from the association list of available asset to be used in network connections. |
UploadFile | WS-AddFile | integration/api/odata/PDUs({key})/UploadFile(File={file}) | |
DeleteFile | WS-ModifyFile | integration/api/odata/PDUs({key})/DeleteFile(FileName={filename}) | |
PDUs Functions
|
Function | Required Permission(s) | Link | Description |
---|
GetTotalSystemPowerConsumption | WS-ReadPDU | integration/api/odata/PDUs({key})/GetTotalSystemPowerConsumption | Function that returns the TotalSystemPowerConsumption for the selected asset. |
GetRealTimePowerInfo | WS-ReadPDU | integration/api/odata/PDUs({key})/GetRealTimePowerInfo | |
GetDiscoveryAssetPage | WS-ReadPDU | integration/api/odata/PDUs({key})/GetDiscoveryAssetPage | Function that returns a collection of entities of type Nlyte.Model.AssetMapping. Used to determine external providers. |
RecordModifiedInfo | WS-ReadPDU | integration/api/odata/PDUs({key})/RecordModifiedInfo | Function that returns an entity of type Nlyte.Model.AuditLogInfo and provides information regarding last modifications against the current asset |
GetMountedChildAssets | | integration/api/odata/PDUs({key})/GetMountedChildAssets(IncludeHosts={includehosts}, IncludeCards={includecards}) | Function that returns a collection of entities of type Nlyte.Model.MountedAssetSummary representing the list of mounted assets in the provided asset. The function is called as follows: Assets(AssetID)/GetMountedChildAssets(IncludeHosts=true,IncludeCards=true) where AssetID is the parent for which the children are retrieved. |
GetDistributorsWithFreeOutlets | WS-ReadAssetToAssetMapping | integration/api/odata/PDUs({key})/GetDistributorsWithFreeOutlets(SearchTerm={searchterm}, SearchTermOption={searchtermoption}, LocationDepth={locationdepth}, MaterialTypeID={materialtypeid}, MaterialSubtypeID={materialsubtypeid}) | Function that returns a collection of entities of type Nlyte.Model.Distributor representing available power suppliers. |
SearchAssetNetworkPortLinkage | WS-ReadNetworkConnection | integration/api/odata/PDUs({key})/SearchAssetNetworkPortLinkage(SearchTerm={searchterm}, SearchTermOption={searchtermoption}, CabinetMountingStatus={cabinetmountingstatus}, LocationTarget={locationtarget}, NetworkTypes={networktypes}, PortLocation={portlocation}) | Function that returns a collection of entities of type Nlyte.Model.AssetNetworkPortLinkage representing available assets to be used in network connections. |
GetRealTimeValues | WS-ReadAssetRealtimeData | integration/api/odata/PDUs({key})/GetRealTimeValues | Function that returns a collection of entities of type Nlyte.Model.RealTimeValue. |
GetAssetSummaries | | integration/api/odata/PDUs({key})/GetAssetSummaries(OwnedPeripherals={ownedperipherals}, IncludeHosts={includehosts}) | |
GetNetworkCardPortsInfo | WS-ReadNetworkConnection | integration/api/odata/PDUs({key})/GetNetworkCardPortsInfo | Returns an object of type Nlyte.Model.NetworkResults having information about Copper and Fiber Ports |
GetNetworkCardPortConnections | WS-ReadNetworkConnection | integration/api/odata/PDUs({key})/GetNetworkCardPortConnections | Returns an object of type Nlyte.Model.NetworkResults having information about Copper and Fiber Port connections |
GetNetworkAssetSummary | WS-ReadNetworkConnection | integration/api/odata/PDUs({key})/GetNetworkAssetSummary | Returns an object of type Nlyte.Model.NetworkResults having information about the networkable assets. |
ListPowerConsumers | | integration/api/odata/PDUs({key})/ListPowerConsumers | Function that returns a collection of Nlyte.Model.Graph entities. Used to identify available Output Connector used in power connections. |
SupportsPlannedMove | | integration/api/odata/PDUs({key})/SupportsPlannedMove | |
GetTotalSystemWeight | | integration/api/odata/PDUs({key})/GetTotalSystemWeight | Function that returns the TotalSystemWeight for the selected asset. |
GetMountedOnAssetID | | integration/api/odata/PDUs({key})/GetMountedOnAssetID | |
GetAssetsReportData | WS-ReadNetwork,WS-ReadCabinet,WS-ReadPeripheral,WS-ReadKVMSwitch,WS-ReadServer,WS-ReadPDU,WS-ReadPowerStrip,WS-ReadAirConditioning,WS-ReadReceptacle,WS-ReadChassis,WS-ReadUPS,WS-ReadAuxiliary,WS-ReadStaticSwitch,WS-ReadServerHost | integration/api/odata/PDUs/GetAssetsReportData(assetIds={assetids}) | |
DownloadFile | WS-ReadFile | integration/api/odata/PDUs({key})/DownloadFile(FileName={filename}) | |
GetAuditLogData | WS-ReadAuditLog | integration/api/odata/PDUs({key})/GetAuditLogData | Function used to export all audit information for a specific entity. Please use the following Content-Type:application/vnd.openxmlformats-officedocument.spreadsheetml.sheet for file download |
PDUs Custom Routes
|
CustomRoute | Required Permission(s) | Supported Method(s) | Description |
---|
integration/api/odata/PDUs({key})/Wires | |
GET
| |
integration/api/odata/PDUs({key})/Notes({relatedKey}) | |
GET
| |
integration/api/odata/PDUs({key})/Notes | |
GET
| |
integration/api/odata/PDUs({key})/Notes | |
POST
| |
integration/api/odata/PDUs({key})/Notes | |
DELETE
| |
integration/api/odata/PDUs({key})/Notes({relatedKey}) | |
DELETE
| |
integration/api/odata/PDUs({key})/Notes({relatedKey}) | |
PATCH
| |
integration/api/odata/PDUs({key})/Utilities | |
GET
| |
integration/api/odata/PDUs({key})/Utilities({relatedKey}) | |
GET
| |
integration/api/odata/PDUs({key})/Utilities({relatedKey}) | |
DELETE
| |
integration/api/odata/PDUs({key})/Graphs | |
GET
| |
integration/api/odata/PDUs({key})/Graphs({relatedKey}) | |
GET
| |
integration/api/odata/PDUs({key})/Graphs({relatedKey}) | |
PATCH
| |
integration/api/odata/PDUs({key})/Graphs | |
POST
| |
integration/api/odata/PDUs({key})/Graphs({relatedKey}) | |
DELETE
| |
integration/api/odata/PDUs({key})/GetAvailableCabinetUs(CabinetID={cabinetId}) | WS-ReadCabinet |
GET
| |
integration/api/odata/PDUs({key})/GetServiceRequests | |
GET
| |
integration/api/odata/PDUs({key})/CustomFields | WS-ReadCustomFieldPDU |
GET
| |
integration/api/odata/PDUs({key})/CustomFields | WS-ModifyCustomFieldPDU |
POST
| |
integration/api/odata/PDUs({key})/CustomFields({relatedKey}) | WS-ModifyCustomFieldPDU |
PATCH
| |
integration/api/odata/PDUs({key})/CustomFields({relatedKey}) | WS-ModifyCustomFieldPDU |
DELETE
| |
integration/api/odata/PDUs({key})/Warranty | WS-ReadPDU |
GET
| |
integration/api/odata/PDUs({key})/Warranty | WS-ModifyPDU |
POST
| |
integration/api/odata/PDUs({key})/Warranty | WS-ModifyPDU |
PATCH
| |
integration/api/odata/PDUs({key})/Warranty | WS-ModifyPDU |
DELETE
| |
integration/api/odata/PDUs({key})/Maintenance | WS-ReadPDU |
GET
| |
integration/api/odata/PDUs({key})/Maintenance | WS-ModifyPDU |
POST
| |
integration/api/odata/PDUs({key})/Maintenance | WS-ModifyPDU |
PATCH
| |
integration/api/odata/PDUs({key})/Maintenance | WS-ModifyPDU |
DELETE
| |
integration/api/odata/PDUs({key})/AssetMounting | |
GET
| |
integration/api/odata/PDUs({key})/Ownership | WS-ReadBusinessGroupAssetMap |
GET
| |
integration/api/odata/PDUs({key})/Ownership({relatedKey}) | WS-ReadBusinessGroupAssetMap |
GET
| |
integration/api/odata/PDUs({key})/Ownership | WS-AddBusinessGroupAssetMap |
POST
| |
integration/api/odata/PDUs({key})/Ownership({relatedKey}) | WS-ModifyBusinessGroupAssetMap |
PATCH
| |
integration/api/odata/PDUs({key})/Ownership({relatedKey}) | WS-ModifyBusinessGroupAssetMap |
DELETE
| |
integration/api/odata/PDUs({key})/Support | WS-ReadSupportGroupAssetMap |
GET
| |
integration/api/odata/PDUs({key})/Support({relatedKey}) | WS-ReadSupportGroupAssetMap |
GET
| |
integration/api/odata/PDUs({key})/Support | WS-AddSupportGroupAssetMap |
POST
| |
integration/api/odata/PDUs({key})/Support({relatedKey}) | WS-ModifySupportGroupAssetMap |
PATCH
| |
integration/api/odata/PDUs({key})/Support({relatedKey}) | WS-ModifySupportGroupAssetMap |
DELETE
| |
integration/api/odata/PDUs({key})/AssociatedAssets({relatedKey}) | |
DELETE
| |
integration/api/odata/PDUs({key})/AssociatedAssets({relatedKey})/Notes({nestedRelatedKey}) | |
GET
| |
integration/api/odata/PDUs({key})/AssociatedAssets({relatedKey})/Notes | |
GET
| |
integration/api/odata/PDUs({key})/AssociatedAssets({relatedKey})/Notes({nestedRelatedKey}) | |
PATCH
| |
integration/api/odata/PDUs({key})/AssociatedAssets({relatedKey})/Notes | |
POST
| |
integration/api/odata/PDUs({key})/AssociatedAssets({relatedKey})/Notes | |
DELETE
| |
integration/api/odata/PDUs({key})/AssociatedAssets({relatedKey})/Notes({nestedRelatedKey}) | |
DELETE
| |
integration/api/odata/PDUs/In(Ids={ids}) | |
GET
| |
integration/api/odata/PDUs/NotIn(Ids={ids}) | |
GET
| |
integration/api/odata/PDUs({key})/Files | |
DELETE
| |
PDUs Nested Properties
|
NestedProperty | Supported Method(s) |
---|
Ownership |
BIND
POST
PATCH
|
Support |
BIND
POST
PATCH
|
CustomFields |
POST
PATCH
|
Maintenance |
POST
PATCH
|
Warranty |
POST
PATCH
|
AssetIPAddressMap |
POST
PATCH
|
LocationGroup | |
AssociatedAssets |
BIND
|
Utilities |
POST
PATCH
|
BreakerPanels |
POST
PATCH
|
Graphs |
POST
PATCH
|
UMounting |
POST
PATCH
|
OutputConnectors |
PATCH
|
Verb(s) | Required Permission(s) | Link | Description |
---|
POST | WS-AddPeripheralMaterial | integration/api/odata/PeripheralMaterials | |
PATCH | WS-ModifyPeripheralMaterial | integration/api/odata/PeripheralMaterials({key}) | |
DELETE | WS-ModifyPeripheralMaterial | integration/api/odata/PeripheralMaterials({key}) | |
GET | WS-ReadPeripheralMaterial | integration/api/odata/PeripheralMaterials | |
GET | WS-ReadPeripheralMaterial | integration/api/odata/PeripheralMaterials({key}) | |
PeripheralMaterials Actions
|
Action | Required Permission(s) | Link | Description |
---|
Cancel | WS-ModifyPeripheralMaterial | integration/api/odata/PeripheralMaterials({key})/Cancel | |
Activate | WS-ModifyPeripheralMaterial | integration/api/odata/PeripheralMaterials({key})/Activate | Function that will move a material in Active status. |
Deactivate | WS-ModifyPeripheralMaterial | integration/api/odata/PeripheralMaterials({key})/Deactivate | Function that will move a material in Inactive status. |
UploadFile | WS-AddFile | integration/api/odata/PeripheralMaterials({key})/UploadFile(File={file}) | |
DeleteFile | WS-ModifyFile | integration/api/odata/PeripheralMaterials({key})/DeleteFile(FileName={filename}) | |
PeripheralMaterials Functions
|
Function | Required Permission(s) | Link | Description |
---|
DownloadFile | WS-ReadFile | integration/api/odata/PeripheralMaterials({key})/DownloadFile(FileName={filename}) | |
GetAuditLogData | WS-ReadAuditLog | integration/api/odata/PeripheralMaterials({key})/GetAuditLogData | Function used to export all audit information for a specific entity. Please use the following Content-Type:application/vnd.openxmlformats-officedocument.spreadsheetml.sheet for file download |
PeripheralMaterials Custom Routes
|
CustomRoute | Required Permission(s) | Supported Method(s) | Description |
---|
integration/api/odata/PeripheralMaterials({key}) | |
POST
| |
integration/api/odata/PeripheralMaterials({key}) | |
POST
| |
integration/api/odata/PeripheralMaterials/In(Ids={ids}) | |
GET
| |
integration/api/odata/PeripheralMaterials/NotIn(Ids={ids}) | |
GET
| |
integration/api/odata/PeripheralMaterials({key})/Files | |
DELETE
| |
PeripheralMaterials Nested Properties
No nested properties
Verb(s) | Required Permission(s) | Link | Description |
---|
POST | WS-ModifyPeripheral | integration/api/odata/Peripherals({key}) | |
PATCH | WS-ModifyPeripheral | integration/api/odata/Peripherals({key}) | |
POST | WS-AddPeripheral | integration/api/odata/Peripherals | |
DELETE | WS-ModifyPeripheral | integration/api/odata/Peripherals({key}) | |
GET | WS-ReadPeripheral | integration/api/odata/Peripherals | |
GET | WS-ReadPeripheral | integration/api/odata/Peripherals({key}) | |
Peripherals Actions
|
Action | Required Permission(s) | Link | Description |
---|
BeginMove | WS-PlanMovePeripheral, WS-PlanRecyclePeripheral, WS-PlanDecommissionPeripheral | integration/api/odata/Peripherals({key})/BeginMove(RelocateType={relocatetype}) | Function that is used to move the selected asset in a planned state, Moving, Recycling or Decommissioning, depending on the RelocateType provided as parameter. The response contains the Planned AssetId. |
CancelMove | WS-CancelMovePeripheral, WS-CancelRecyclePeripheral, WS-CancelDecommissionPeripheral | integration/api/odata/Peripherals({key})/CancelMove | Function that is used to cancel planned action. The selected asset will become Active/Operational. |
CompleteMove | WS-CompleteMovePeripheral, WS-CompleteRecyclePeripheral, WS-CompleteDecommissionPeripheral | integration/api/odata/Peripherals({key})/CompleteMove | Function that is used to finish planned action. The selected asset will become Active/Operational, Recycled/Available or Decommissioned/Decommissioned, depending on the Planned entity type (Move, Recycle or Deccommission). |
DirectMove | WS-SetLocationPeripheral | integration/api/odata/Peripherals({key})/DirectMove(RelocateType={relocatetype}, LocationGroupID={locationgroupid}) | Function that is used to directly move an asset to a new location in a final state. |
CompleteCreation | WS-ModifyPeripheral | integration/api/odata/Peripherals({key})/CompleteCreation | Function that moves an asset from Planned/(Pre)Procurement to Active/Operational. |
SetMaterial | | integration/api/odata/Peripherals({key})/SetMaterial(NewMaterialID={newmaterialid}) | Function that is used to change the material on an existing asset. This action is only supported for Receptacles and Power Strips. |
AddRealTimeValues | WS-AddAssetRealtimeData | integration/api/odata/Peripherals({key})/AddRealTimeValues(RealTimeInfo={realtimeinfo}, RealTimeValue={realtimevalue}) | Adds a provider specfic recorded real-time value against an asset or its associated outlet. Custom metrics are only allowed on assets whereas load, power and voltage metrics are allowed against assets, outlets or their relevant phases. |
AddNetworkAsset | WS-ReadNetworkConnection,WS-AddNetworkConnection | integration/api/odata/Peripherals({key})/AddNetworkAsset(NetworkAssetId={networkassetid}) | Function that is adding the selected asset in the list of available asset to be used in network connections. The mapping between the two assets is created by providing the NetworkAssetId parameter in the BODY, NetworkAssetId representing the AssetID of the asset to be added in the list of available assets. |
RemoveNetworkAsset | WS-ModifyNetworkConnection | integration/api/odata/Peripherals({key})/RemoveNetworkAsset(NetworkAssetId={networkassetid}, NetworkLinkerType={networklinkertype}) | Function that removes an asset from the association list of available asset to be used in network connections. |
UploadFile | WS-AddFile | integration/api/odata/Peripherals({key})/UploadFile(File={file}) | |
DeleteFile | WS-ModifyFile | integration/api/odata/Peripherals({key})/DeleteFile(FileName={filename}) | |
Peripherals Functions
|
Function | Required Permission(s) | Link | Description |
---|
GetTotalSystemPowerConsumption | WS-ReadPeripheral | integration/api/odata/Peripherals({key})/GetTotalSystemPowerConsumption | Function that returns the TotalSystemPowerConsumption for the selected asset. |
GetRealTimePowerInfo | WS-ReadPeripheral | integration/api/odata/Peripherals({key})/GetRealTimePowerInfo | |
GetDiscoveryAssetPage | WS-ReadPeripheral | integration/api/odata/Peripherals({key})/GetDiscoveryAssetPage | Function that returns a collection of entities of type Nlyte.Model.AssetMapping. Used to determine external providers. |
RecordModifiedInfo | WS-ReadPeripheral | integration/api/odata/Peripherals({key})/RecordModifiedInfo | Function that returns an entity of type Nlyte.Model.AuditLogInfo and provides information regarding last modifications against the current asset |
GetMountedChildAssets | | integration/api/odata/Peripherals({key})/GetMountedChildAssets(IncludeHosts={includehosts}, IncludeCards={includecards}) | Function that returns a collection of entities of type Nlyte.Model.MountedAssetSummary representing the list of mounted assets in the provided asset. The function is called as follows: Assets(AssetID)/GetMountedChildAssets(IncludeHosts=true,IncludeCards=true) where AssetID is the parent for which the children are retrieved. |
GetDistributorsWithFreeOutlets | WS-ReadAssetToAssetMapping | integration/api/odata/Peripherals({key})/GetDistributorsWithFreeOutlets(SearchTerm={searchterm}, SearchTermOption={searchtermoption}, LocationDepth={locationdepth}, MaterialTypeID={materialtypeid}, MaterialSubtypeID={materialsubtypeid}) | Function that returns a collection of entities of type Nlyte.Model.Distributor representing available power suppliers. |
SearchAssetNetworkPortLinkage | WS-ReadNetworkConnection | integration/api/odata/Peripherals({key})/SearchAssetNetworkPortLinkage(SearchTerm={searchterm}, SearchTermOption={searchtermoption}, CabinetMountingStatus={cabinetmountingstatus}, LocationTarget={locationtarget}, NetworkTypes={networktypes}, PortLocation={portlocation}) | Function that returns a collection of entities of type Nlyte.Model.AssetNetworkPortLinkage representing available assets to be used in network connections. |
GetRealTimeValues | WS-ReadAssetRealtimeData | integration/api/odata/Peripherals({key})/GetRealTimeValues | Function that returns a collection of entities of type Nlyte.Model.RealTimeValue. |
GetAssetSummaries | | integration/api/odata/Peripherals({key})/GetAssetSummaries(OwnedPeripherals={ownedperipherals}, IncludeHosts={includehosts}) | |
GetNetworkCardPortsInfo | WS-ReadNetworkConnection | integration/api/odata/Peripherals({key})/GetNetworkCardPortsInfo | Returns an object of type Nlyte.Model.NetworkResults having information about Copper and Fiber Ports |
GetNetworkCardPortConnections | WS-ReadNetworkConnection | integration/api/odata/Peripherals({key})/GetNetworkCardPortConnections | Returns an object of type Nlyte.Model.NetworkResults having information about Copper and Fiber Port connections |
GetNetworkAssetSummary | WS-ReadNetworkConnection | integration/api/odata/Peripherals({key})/GetNetworkAssetSummary | Returns an object of type Nlyte.Model.NetworkResults having information about the networkable assets. |
ListPowerConsumers | | integration/api/odata/Peripherals({key})/ListPowerConsumers | Function that returns a collection of Nlyte.Model.Graph entities. Used to identify available Output Connector used in power connections. |
SupportsPlannedMove | | integration/api/odata/Peripherals({key})/SupportsPlannedMove | |
GetTotalSystemWeight | | integration/api/odata/Peripherals({key})/GetTotalSystemWeight | Function that returns the TotalSystemWeight for the selected asset. |
GetMountedOnAssetID | | integration/api/odata/Peripherals({key})/GetMountedOnAssetID | |
GetAssetsReportData | WS-ReadNetwork,WS-ReadCabinet,WS-ReadPeripheral,WS-ReadKVMSwitch,WS-ReadServer,WS-ReadPDU,WS-ReadPowerStrip,WS-ReadAirConditioning,WS-ReadReceptacle,WS-ReadChassis,WS-ReadUPS,WS-ReadAuxiliary,WS-ReadStaticSwitch,WS-ReadServerHost | integration/api/odata/Peripherals/GetAssetsReportData(assetIds={assetids}) | |
DownloadFile | WS-ReadFile | integration/api/odata/Peripherals({key})/DownloadFile(FileName={filename}) | |
GetAuditLogData | WS-ReadAuditLog | integration/api/odata/Peripherals({key})/GetAuditLogData | Function used to export all audit information for a specific entity. Please use the following Content-Type:application/vnd.openxmlformats-officedocument.spreadsheetml.sheet for file download |
Peripherals Custom Routes
|
CustomRoute | Required Permission(s) | Supported Method(s) | Description |
---|
integration/api/odata/Peripherals({key})/Notes({relatedKey}) | |
GET
| |
integration/api/odata/Peripherals({key})/Notes | |
GET
| |
integration/api/odata/Peripherals({key})/Notes | |
POST
| |
integration/api/odata/Peripherals({key})/Notes | |
DELETE
| |
integration/api/odata/Peripherals({key})/Notes({relatedKey}) | |
DELETE
| |
integration/api/odata/Peripherals({key})/Notes({relatedKey}) | |
PATCH
| |
integration/api/odata/Peripherals({key})/Graphs | |
GET
| |
integration/api/odata/Peripherals({key})/Graphs({relatedKey}) | |
GET
| |
integration/api/odata/Peripherals({key})/Graphs({relatedKey}) | |
PATCH
| |
integration/api/odata/Peripherals({key})/Graphs | |
POST
| |
integration/api/odata/Peripherals({key})/Graphs({relatedKey}) | |
DELETE
| |
integration/api/odata/Peripherals({key})/GetAvailableCabinetUs(CabinetID={cabinetId}) | WS-ReadCabinet |
GET
| |
integration/api/odata/Peripherals({key})/ConnectedAssets({relatedKey}) | |
DELETE
| |
integration/api/odata/Peripherals({key})/GetServiceRequests | |
GET
| |
integration/api/odata/Peripherals({key})/CustomFields | WS-ReadCustomFieldPeripheral |
GET
| |
integration/api/odata/Peripherals({key})/ConnectedAssets | |
POST
| |
integration/api/odata/Peripherals({key})/CustomFields | WS-ModifyCustomFieldPeripheral |
POST
| |
integration/api/odata/Peripherals({key})/CustomFields({relatedKey}) | WS-ModifyCustomFieldPeripheral |
PATCH
| |
integration/api/odata/Peripherals({key})/CustomFields({relatedKey}) | WS-ModifyCustomFieldPeripheral |
DELETE
| |
integration/api/odata/Peripherals({key})/Warranty | WS-ReadPeripheral |
GET
| |
integration/api/odata/Peripherals({key})/Warranty | WS-ModifyPeripheral |
POST
| |
integration/api/odata/Peripherals({key})/Warranty | WS-ModifyPeripheral |
PATCH
| |
integration/api/odata/Peripherals({key})/Warranty | WS-ModifyPeripheral |
DELETE
| |
integration/api/odata/Peripherals({key})/Maintenance | WS-ReadPeripheral |
GET
| |
integration/api/odata/Peripherals({key})/Maintenance | WS-ModifyPeripheral |
POST
| |
integration/api/odata/Peripherals({key})/Maintenance | WS-ModifyPeripheral |
PATCH
| |
integration/api/odata/Peripherals({key})/Maintenance | WS-ModifyPeripheral |
DELETE
| |
integration/api/odata/Peripherals({key})/AssetMounting | |
GET
| |
integration/api/odata/Peripherals({key})/Ownership | WS-ReadBusinessGroupAssetMap |
GET
| |
integration/api/odata/Peripherals({key})/Ownership({relatedKey}) | WS-ReadBusinessGroupAssetMap |
GET
| |
integration/api/odata/Peripherals({key})/Ownership | WS-AddBusinessGroupAssetMap |
POST
| |
integration/api/odata/Peripherals({key})/Ownership({relatedKey}) | WS-ModifyBusinessGroupAssetMap |
PATCH
| |
integration/api/odata/Peripherals({key})/Ownership({relatedKey}) | WS-ModifyBusinessGroupAssetMap |
DELETE
| |
integration/api/odata/Peripherals({key})/Support | WS-ReadSupportGroupAssetMap |
GET
| |
integration/api/odata/Peripherals({key})/Support({relatedKey}) | WS-ReadSupportGroupAssetMap |
GET
| |
integration/api/odata/Peripherals({key})/Support | WS-AddSupportGroupAssetMap |
POST
| |
integration/api/odata/Peripherals({key})/Support({relatedKey}) | WS-ModifySupportGroupAssetMap |
PATCH
| |
integration/api/odata/Peripherals({key})/AssociatedAssets({relatedKey}) | |
DELETE
| |
integration/api/odata/Peripherals({key})/AssociatedAssets({relatedKey})/Notes({nestedRelatedKey}) | |
GET
| |
integration/api/odata/Peripherals({key})/AssociatedAssets({relatedKey})/Notes | |
GET
| |
integration/api/odata/Peripherals({key})/AssociatedAssets({relatedKey})/Notes({nestedRelatedKey}) | |
PATCH
| |
integration/api/odata/Peripherals({key})/AssociatedAssets({relatedKey})/Notes | |
POST
| |
integration/api/odata/Peripherals({key})/AssociatedAssets({relatedKey})/Notes | |
DELETE
| |
integration/api/odata/Peripherals({key})/AssociatedAssets({relatedKey})/Notes({nestedRelatedKey}) | |
DELETE
| |
integration/api/odata/Peripherals({key})/Support({relatedKey}) | WS-ModifySupportGroupAssetMap |
DELETE
| |
integration/api/odata/Peripherals/In(Ids={ids}) | |
GET
| |
integration/api/odata/Peripherals/NotIn(Ids={ids}) | |
GET
| |
integration/api/odata/Peripherals({key})/Files | |
DELETE
| |
Peripherals Nested Properties
|
NestedProperty | Supported Method(s) |
---|
Ownership |
BIND
POST
PATCH
|
Support |
BIND
POST
PATCH
|
CustomFields |
POST
PATCH
|
Maintenance |
POST
PATCH
|
Warranty |
POST
PATCH
|
AssetIPAddressMap |
POST
PATCH
|
LocationGroup | |
AssociatedAssets |
BIND
|
InputConnectors |
PATCH
|
ConnectedAssets |
BIND
|
Graphs |
POST
PATCH
|
UMounting |
POST
PATCH
|
Verb(s) | Required Permission(s) | Link | Description |
---|
GET | | integration/api/odata/Permissions | |
GET | | integration/api/odata/Permissions({key}) | |
Permissions Actions
No actions
Permissions Functions
No functions
Permissions Custom Routes
|
CustomRoute | Required Permission(s) | Supported Method(s) | Description |
---|
integration/api/odata/Permissions/In(Ids={ids}) | |
GET
| |
integration/api/odata/Permissions/NotIn(Ids={ids}) | |
GET
| |
Permissions Nested Properties
No nested properties
Verb(s) | Required Permission(s) | Link | Description |
---|
GET | | integration/api/odata/PollTypes | |
GET | | integration/api/odata/PollTypes({key}) | |
PollTypes Actions
No actions
PollTypes Functions
No functions
PollTypes Custom Routes
|
CustomRoute | Required Permission(s) | Supported Method(s) | Description |
---|
integration/api/odata/PollTypes/In(Ids={ids}) | |
GET
| |
integration/api/odata/PollTypes/NotIn(Ids={ids}) | |
GET
| |
PollTypes Nested Properties
No nested properties
Verb(s) | Required Permission(s) | Link | Description |
---|
POST | WS-ModifyPowerStripMaterial | integration/api/odata/PowerStripMaterials({key}) | |
POST | WS-AddPowerStripMaterial | integration/api/odata/PowerStripMaterials | |
PATCH | WS-ModifyPowerStripMaterial | integration/api/odata/PowerStripMaterials({key}) | |
DELETE | WS-ModifyPowerStripMaterial | integration/api/odata/PowerStripMaterials({key}) | |
GET | WS-ReadPowerStripMaterial | integration/api/odata/PowerStripMaterials | |
GET | WS-ReadPowerStripMaterial | integration/api/odata/PowerStripMaterials({key}) | |
PowerStripMaterials Actions
|
Action | Required Permission(s) | Link | Description |
---|
Cancel | WS-ModifyPowerStripMaterial | integration/api/odata/PowerStripMaterials({key})/Cancel | |
Activate | WS-ModifyPowerStripMaterial | integration/api/odata/PowerStripMaterials({key})/Activate | Function that will move a material in Active status. |
Deactivate | WS-ModifyPowerStripMaterial | integration/api/odata/PowerStripMaterials({key})/Deactivate | Function that will move a material in Inactive status. |
UploadFile | WS-AddFile | integration/api/odata/PowerStripMaterials({key})/UploadFile(File={file}) | |
DeleteFile | WS-ModifyFile | integration/api/odata/PowerStripMaterials({key})/DeleteFile(FileName={filename}) | |
PowerStripMaterials Functions
|
Function | Required Permission(s) | Link | Description |
---|
DownloadFile | WS-ReadFile | integration/api/odata/PowerStripMaterials({key})/DownloadFile(FileName={filename}) | |
GetAuditLogData | WS-ReadAuditLog | integration/api/odata/PowerStripMaterials({key})/GetAuditLogData | Function used to export all audit information for a specific entity. Please use the following Content-Type:application/vnd.openxmlformats-officedocument.spreadsheetml.sheet for file download |
PowerStripMaterials Custom Routes
|
CustomRoute | Required Permission(s) | Supported Method(s) | Description |
---|
integration/api/odata/PowerStripMaterials/In(Ids={ids}) | |
GET
| |
integration/api/odata/PowerStripMaterials/NotIn(Ids={ids}) | |
GET
| |
integration/api/odata/PowerStripMaterials({key})/Files | |
DELETE
| |
PowerStripMaterials Nested Properties
No nested properties
Verb(s) | Required Permission(s) | Link | Description |
---|
POST | WS-ModifyPowerStrip | integration/api/odata/PowerStrips({key}) | |
POST | WS-AddPowerStrip | integration/api/odata/PowerStrips | |
PATCH | WS-ModifyPowerStrip | integration/api/odata/PowerStrips({key}) | |
DELETE | WS-ModifyPowerStrip | integration/api/odata/PowerStrips({key}) | |
GET | WS-ReadPowerStrip | integration/api/odata/PowerStrips | |
GET | WS-ReadPowerStrip | integration/api/odata/PowerStrips({key}) | |
PowerStrips Actions
|
Action | Required Permission(s) | Link | Description |
---|
SetMaterial | WS-SetMaterialPowerStrip | integration/api/odata/PowerStrips({key})/SetMaterial(NewMaterialID={newmaterialid}) | Function that is used to change the material on an existing power strip. The material for the selected power strip is swapped with the new material by providing the NewMaterialID parameter in the BODY. The response contains the new AssetID of the power strip after the material has been replaced. |
BeginMove | WS-PlanDecommissionPowerStrip | integration/api/odata/PowerStrips({key})/BeginMove(RelocateType={relocatetype}) | Function that is used to move the selected asset in a planned state, Moving, Recycling or Decommissioning, depending on the RelocateType provided as parameter. The response contains the Planned AssetId. |
CancelMove | WS-CancelDecommissionPowerStrip | integration/api/odata/PowerStrips({key})/CancelMove | Function that is used to cancel planned action. The selected asset will become Active/Operational. |
CompleteMove | WS-CompleteDecommissionPowerStrip | integration/api/odata/PowerStrips({key})/CompleteMove | Function that is used to finish planned action. The selected asset will become Active/Operational, Recycled/Available or Decommissioned/Decommissioned, depending on the Planned entity type (Move, Recycle or Deccommission). |
DirectMove | WS-SetLocationPowerStrip | integration/api/odata/PowerStrips({key})/DirectMove(RelocateType={relocatetype}, LocationGroupID={locationgroupid}) | Function that is used to directly move an asset to a new location in a final state. |
CompleteCreation | WS-ModifyPowerStrip | integration/api/odata/PowerStrips({key})/CompleteCreation | Function that moves an asset from Planned/(Pre)Procurement to Active/Operational. |
AddRealTimeValues | WS-AddAssetRealtimeData | integration/api/odata/PowerStrips({key})/AddRealTimeValues(RealTimeInfo={realtimeinfo}, RealTimeValue={realtimevalue}) | Adds a provider specfic recorded real-time value against an asset or its associated outlet. Custom metrics are only allowed on assets whereas load, power and voltage metrics are allowed against assets, outlets or their relevant phases. |
AddNetworkAsset | WS-ReadNetworkConnection,WS-AddNetworkConnection | integration/api/odata/PowerStrips({key})/AddNetworkAsset(NetworkAssetId={networkassetid}) | Function that is adding the selected asset in the list of available asset to be used in network connections. The mapping between the two assets is created by providing the NetworkAssetId parameter in the BODY, NetworkAssetId representing the AssetID of the asset to be added in the list of available assets. |
RemoveNetworkAsset | WS-ModifyNetworkConnection | integration/api/odata/PowerStrips({key})/RemoveNetworkAsset(NetworkAssetId={networkassetid}, NetworkLinkerType={networklinkertype}) | Function that removes an asset from the association list of available asset to be used in network connections. |
UploadFile | WS-AddFile | integration/api/odata/PowerStrips({key})/UploadFile(File={file}) | |
DeleteFile | WS-ModifyFile | integration/api/odata/PowerStrips({key})/DeleteFile(FileName={filename}) | |
PowerStrips Functions
|
Function | Required Permission(s) | Link | Description |
---|
GetTotalSystemPowerConsumption | WS-ReadPowerStrip | integration/api/odata/PowerStrips({key})/GetTotalSystemPowerConsumption | Function that returns the TotalSystemPowerConsumption for the selected asset. |
GetRealTimePowerInfo | WS-ReadPowerStrip | integration/api/odata/PowerStrips({key})/GetRealTimePowerInfo | |
GetDiscoveryAssetPage | WS-ReadPowerStrip | integration/api/odata/PowerStrips({key})/GetDiscoveryAssetPage | Function that returns a collection of entities of type Nlyte.Model.AssetMapping. Used to determine external providers. |
RecordModifiedInfo | WS-ReadPowerStrip | integration/api/odata/PowerStrips({key})/RecordModifiedInfo | Function that returns an entity of type Nlyte.Model.AuditLogInfo and provides information regarding last modifications against the current asset |
GetMountedChildAssets | | integration/api/odata/PowerStrips({key})/GetMountedChildAssets(IncludeHosts={includehosts}, IncludeCards={includecards}) | Function that returns a collection of entities of type Nlyte.Model.MountedAssetSummary representing the list of mounted assets in the provided asset. The function is called as follows: Assets(AssetID)/GetMountedChildAssets(IncludeHosts=true,IncludeCards=true) where AssetID is the parent for which the children are retrieved. |
GetDistributorsWithFreeOutlets | WS-ReadAssetToAssetMapping | integration/api/odata/PowerStrips({key})/GetDistributorsWithFreeOutlets(SearchTerm={searchterm}, SearchTermOption={searchtermoption}, LocationDepth={locationdepth}, MaterialTypeID={materialtypeid}, MaterialSubtypeID={materialsubtypeid}) | Function that returns a collection of entities of type Nlyte.Model.Distributor representing available power suppliers. |
SearchAssetNetworkPortLinkage | WS-ReadNetworkConnection | integration/api/odata/PowerStrips({key})/SearchAssetNetworkPortLinkage(SearchTerm={searchterm}, SearchTermOption={searchtermoption}, CabinetMountingStatus={cabinetmountingstatus}, LocationTarget={locationtarget}, NetworkTypes={networktypes}, PortLocation={portlocation}) | Function that returns a collection of entities of type Nlyte.Model.AssetNetworkPortLinkage representing available assets to be used in network connections. |
GetRealTimeValues | WS-ReadAssetRealtimeData | integration/api/odata/PowerStrips({key})/GetRealTimeValues | Function that returns a collection of entities of type Nlyte.Model.RealTimeValue. |
GetAssetSummaries | | integration/api/odata/PowerStrips({key})/GetAssetSummaries(OwnedPeripherals={ownedperipherals}, IncludeHosts={includehosts}) | |
GetNetworkCardPortsInfo | WS-ReadNetworkConnection | integration/api/odata/PowerStrips({key})/GetNetworkCardPortsInfo | Returns an object of type Nlyte.Model.NetworkResults having information about Copper and Fiber Ports |
GetNetworkCardPortConnections | WS-ReadNetworkConnection | integration/api/odata/PowerStrips({key})/GetNetworkCardPortConnections | Returns an object of type Nlyte.Model.NetworkResults having information about Copper and Fiber Port connections |
GetNetworkAssetSummary | WS-ReadNetworkConnection | integration/api/odata/PowerStrips({key})/GetNetworkAssetSummary | Returns an object of type Nlyte.Model.NetworkResults having information about the networkable assets. |
ListPowerConsumers | | integration/api/odata/PowerStrips({key})/ListPowerConsumers | Function that returns a collection of Nlyte.Model.Graph entities. Used to identify available Output Connector used in power connections. |
SupportsPlannedMove | | integration/api/odata/PowerStrips({key})/SupportsPlannedMove | |
GetTotalSystemWeight | | integration/api/odata/PowerStrips({key})/GetTotalSystemWeight | Function that returns the TotalSystemWeight for the selected asset. |
GetMountedOnAssetID | | integration/api/odata/PowerStrips({key})/GetMountedOnAssetID | |
GetAssetsReportData | WS-ReadNetwork,WS-ReadCabinet,WS-ReadPeripheral,WS-ReadKVMSwitch,WS-ReadServer,WS-ReadPDU,WS-ReadPowerStrip,WS-ReadAirConditioning,WS-ReadReceptacle,WS-ReadChassis,WS-ReadUPS,WS-ReadAuxiliary,WS-ReadStaticSwitch,WS-ReadServerHost | integration/api/odata/PowerStrips/GetAssetsReportData(assetIds={assetids}) | |
DownloadFile | WS-ReadFile | integration/api/odata/PowerStrips({key})/DownloadFile(FileName={filename}) | |
GetAuditLogData | WS-ReadAuditLog | integration/api/odata/PowerStrips({key})/GetAuditLogData | Function used to export all audit information for a specific entity. Please use the following Content-Type:application/vnd.openxmlformats-officedocument.spreadsheetml.sheet for file download |
PowerStrips Custom Routes
|
CustomRoute | Required Permission(s) | Supported Method(s) | Description |
---|
integration/api/odata/PowerStrips({key})/Wires | |
GET
| |
integration/api/odata/PowerStrips({key})/Notes({relatedKey}) | |
GET
| |
integration/api/odata/PowerStrips({key})/Notes | |
GET
| |
integration/api/odata/PowerStrips({key})/Notes | |
POST
| |
integration/api/odata/PowerStrips({key})/Notes | |
DELETE
| |
integration/api/odata/PowerStrips({key})/Notes({relatedKey}) | |
DELETE
| |
integration/api/odata/PowerStrips({key})/Notes({relatedKey}) | |
PATCH
| |
integration/api/odata/PowerStrips({key})/Utilities | |
GET
| |
integration/api/odata/PowerStrips({key})/Utilities({relatedKey}) | |
GET
| |
integration/api/odata/PowerStrips({key})/Utilities({relatedKey}) | |
DELETE
| |
integration/api/odata/PowerStrips({key})/Graphs | |
GET
| |
integration/api/odata/PowerStrips({key})/Graphs({relatedKey}) | |
GET
| |
integration/api/odata/PowerStrips({key})/Graphs({relatedKey}) | |
PATCH
| |
integration/api/odata/PowerStrips({key})/Graphs | |
POST
| |
integration/api/odata/PowerStrips({key})/Graphs({relatedKey}) | |
DELETE
| |
integration/api/odata/PowerStrips({key})/GetAvailableCabinetUs(CabinetID={cabinetId}) | WS-ReadCabinet |
GET
| |
integration/api/odata/PowerStrips({key})/GetServiceRequests | |
GET
| |
integration/api/odata/PowerStrips({key})/CustomFields | WS-ReadCustomFieldPowerStrip |
GET
| |
integration/api/odata/PowerStrips({key})/CustomFields | WS-ModifyCustomFieldPowerStrip |
POST
| |
integration/api/odata/PowerStrips({key})/CustomFields({relatedKey}) | WS-ModifyCustomFieldPowerStrip |
PATCH
| |
integration/api/odata/PowerStrips({key})/CustomFields({relatedKey}) | WS-ModifyCustomFieldPowerStrip |
DELETE
| |
integration/api/odata/PowerStrips({key})/Warranty | WS-ReadPowerStrip |
GET
| |
integration/api/odata/PowerStrips({key})/Warranty | WS-ModifyPowerStrip |
POST
| |
integration/api/odata/PowerStrips({key})/Warranty | WS-ModifyPowerStrip |
PATCH
| |
integration/api/odata/PowerStrips({key})/Warranty | WS-ModifyPowerStrip |
DELETE
| |
integration/api/odata/PowerStrips({key})/Maintenance | WS-ReadPowerStrip |
GET
| |
integration/api/odata/PowerStrips({key})/Maintenance | WS-ModifyPowerStrip |
POST
| |
integration/api/odata/PowerStrips({key})/Maintenance | WS-ModifyPowerStrip |
PATCH
| |
integration/api/odata/PowerStrips({key})/Maintenance | WS-ModifyPowerStrip |
DELETE
| |
integration/api/odata/PowerStrips({key})/AssetMounting | |
GET
| |
integration/api/odata/PowerStrips({key})/Ownership | WS-ReadBusinessGroupAssetMap |
GET
| |
integration/api/odata/PowerStrips({key})/Ownership({relatedKey}) | WS-ReadBusinessGroupAssetMap |
GET
| |
integration/api/odata/PowerStrips({key})/Ownership | WS-AddBusinessGroupAssetMap |
POST
| |
integration/api/odata/PowerStrips({key})/Ownership({relatedKey}) | WS-ModifyBusinessGroupAssetMap |
PATCH
| |
integration/api/odata/PowerStrips({key})/Ownership({relatedKey}) | WS-ModifyBusinessGroupAssetMap |
DELETE
| |
integration/api/odata/PowerStrips({key})/Support | WS-ReadSupportGroupAssetMap |
GET
| |
integration/api/odata/PowerStrips({key})/Support({relatedKey}) | WS-ReadSupportGroupAssetMap |
GET
| |
integration/api/odata/PowerStrips({key})/Support | WS-AddSupportGroupAssetMap |
POST
| |
integration/api/odata/PowerStrips({key})/Support({relatedKey}) | WS-ModifySupportGroupAssetMap |
PATCH
| |
integration/api/odata/PowerStrips({key})/Support({relatedKey}) | WS-ModifySupportGroupAssetMap |
DELETE
| |
integration/api/odata/PowerStrips({key})/AssociatedAssets({relatedKey}) | |
DELETE
| |
integration/api/odata/PowerStrips({key})/AssociatedAssets({relatedKey})/Notes({nestedRelatedKey}) | |
GET
| |
integration/api/odata/PowerStrips({key})/AssociatedAssets({relatedKey})/Notes | |
GET
| |
integration/api/odata/PowerStrips({key})/AssociatedAssets({relatedKey})/Notes({nestedRelatedKey}) | |
PATCH
| |
integration/api/odata/PowerStrips({key})/AssociatedAssets({relatedKey})/Notes | |
POST
| |
integration/api/odata/PowerStrips({key})/AssociatedAssets({relatedKey})/Notes | |
DELETE
| |
integration/api/odata/PowerStrips({key})/AssociatedAssets({relatedKey})/Notes({nestedRelatedKey}) | |
DELETE
| |
integration/api/odata/PowerStrips/In(Ids={ids}) | |
GET
| |
integration/api/odata/PowerStrips/NotIn(Ids={ids}) | |
GET
| |
integration/api/odata/PowerStrips({key})/Files | |
DELETE
| |
PowerStrips Nested Properties
|
NestedProperty | Supported Method(s) |
---|
Ownership |
BIND
POST
PATCH
|
Support |
BIND
POST
PATCH
|
CustomFields |
POST
PATCH
|
Maintenance |
POST
PATCH
|
Warranty |
POST
PATCH
|
AssetIPAddressMap |
POST
PATCH
|
LocationGroup | |
AssociatedAssets |
BIND
|
Utilities |
POST
PATCH
|
InputConnectors |
PATCH
|
Graphs |
POST
PATCH
|
UMounting |
POST
PATCH
|
OutputConnectors |
PATCH
|
Verb(s) | Required Permission(s) | Link | Description |
---|
PUT | WS-ModifyProcess | integration/api/odata/Processes({key}) | |
POST | WS-AddProcess | integration/api/odata/Processes | |
POST | | integration/api/odata/Processes({key}) | |
PATCH | WS-ModifyProcess | integration/api/odata/Processes({key}) | |
GET | WS-ReadProcess | integration/api/odata/Processes | |
GET | WS-ReadProcess | integration/api/odata/Processes({key}) | |
Processes Actions
|
Action | Required Permission(s) | Link | Description |
---|
Copy | WS-AddProcess | integration/api/odata/Processes({key})/Copy(Name={name}, Description={description}) | |
CalculateDuration | | integration/api/odata/Processes/CalculateDuration(process={process}) | |
SetStatus | WS-ModifyProcess | integration/api/odata/Processes({key})/SetStatus(Status={status}) | |
Import | WS-ReadProcess, WS-AddForm | integration/api/odata/Processes/Import | |
ReplaceForm | WS-ModifyProcess | integration/api/odata/Processes/ReplaceForm(oldFormID={oldformid}, newFormID={newformid}, process={process}) | |
AddLocations | WS-ModifyProcess | integration/api/odata/Processes({key})/AddLocations(locationIds={locationids}, selectedLocationId={selectedlocationid}) | |
RemoveLocations | WS-ModifyProcess | integration/api/odata/Processes({key})/RemoveLocations(locationIds={locationids}, selectedLocationId={selectedlocationid}) | |
Processes Functions
|
Function | Required Permission(s) | Link | Description |
---|
Export | WS-ReadProcess | integration/api/odata/Processes({key})/Export | |
Processes Custom Routes
|
CustomRoute | Required Permission(s) | Supported Method(s) | Description |
---|
integration/api/odata/Processes/In(Ids={ids}) | |
GET
| |
integration/api/odata/Processes/NotIn(Ids={ids}) | |
GET
| |
integration/api/odata/Processes | |
POST
| |
Processes Nested Properties
No nested properties
Verb(s) | Required Permission(s) | Link | Description |
---|
POST | | integration/api/odata/ProjectDependencies | |
PATCH | | integration/api/odata/ProjectDependencies({key}) | |
DELETE | | integration/api/odata/ProjectDependencies({key}) | |
GET | | integration/api/odata/ProjectDependencies | |
GET | | integration/api/odata/ProjectDependencies({key}) | |
ProjectDependencies Actions
No actions
ProjectDependencies Functions
No functions
ProjectDependencies Custom Routes
|
CustomRoute | Required Permission(s) | Supported Method(s) | Description |
---|
integration/api/odata/ProjectDependencies/In(Ids={ids}) | |
GET
| |
integration/api/odata/ProjectDependencies/NotIn(Ids={ids}) | |
GET
| |
ProjectDependencies Nested Properties
No nested properties
Verb(s) | Required Permission(s) | Link | Description |
---|
GET | WS-ReadCabinet,WS-ReadChassis,WS-ReadServer,WS-ReadNetwork,WS-ReadPeripheral,WS-ReadServerHost,WS-ReadNetworkMaterial,WS-ReadCabinetMaterial,WS-ReadChassisMaterial,WS-ReadPeripheralMaterial,WS-ReadServerMaterial | integration/api/odata/ProjectItemAllocateCriterias({key}) | |
PATCH | | integration/api/odata/ProjectItemAllocateCriterias({key}) | |
GET | WS-ReadCabinet,WS-ReadChassis,WS-ReadServer,WS-ReadNetwork,WS-ReadPeripheral,WS-ReadServerHost,WS-ReadNetworkMaterial,WS-ReadCabinetMaterial,WS-ReadChassisMaterial,WS-ReadPeripheralMaterial,WS-ReadServerMaterial | integration/api/odata/ProjectItemAllocateCriterias | |
ProjectItemAllocateCriterias Actions
No actions
ProjectItemAllocateCriterias Functions
No functions
ProjectItemAllocateCriterias Custom Routes
|
CustomRoute | Required Permission(s) | Supported Method(s) | Description |
---|
integration/api/odata/ProjectItemAllocateCriterias/In(Ids={ids}) | |
GET
| |
integration/api/odata/ProjectItemAllocateCriterias/NotIn(Ids={ids}) | |
GET
| |
ProjectItemAllocateCriterias Nested Properties
No nested properties
Verb(s) | Required Permission(s) | Link | Description |
---|
GET | WS-ReadChassis,WS-ReadServer,WS-ReadNetwork,WS-ReadPeripheral,WS-ReadServerHost,WS-ReadNetworkMaterial,WS-ReadChassisMaterial,WS-ReadPeripheralMaterial,WS-ReadServerMaterial | integration/api/odata/ProjectItems | |
GET | WS-ReadChassis,WS-ReadServer,WS-ReadNetwork,WS-ReadPeripheral,WS-ReadServerHost,WS-ReadNetworkMaterial,WS-ReadChassisMaterial,WS-ReadPeripheralMaterial,WS-ReadServerMaterial | integration/api/odata/ProjectItems({key}) | |
POST | WS-ReadChassis,WS-ReadServer,WS-ReadChassisMaterial,WS-ReadServerMaterial | integration/api/odata/ProjectItems | |
DELETE | | integration/api/odata/ProjectItems({key}) | |
PATCH | | integration/api/odata/ProjectItems({key}) | |
ProjectItems Actions
No actions
ProjectItems Functions
No functions
ProjectItems Custom Routes
|
CustomRoute | Required Permission(s) | Supported Method(s) | Description |
---|
integration/api/odata/ProjectItems/In(Ids={ids}) | |
GET
| |
integration/api/odata/ProjectItems/NotIn(Ids={ids}) | |
GET
| |
ProjectItems Nested Properties
|
NestedProperty | Supported Method(s) |
---|
ProjectItemAllocateCriteria |
POST
PATCH
|
Verb(s) | Required Permission(s) | Link | Description |
---|
GET | | integration/api/odata/Projects | |
GET | | integration/api/odata/Projects({key}) | |
POST | | integration/api/odata/Projects | |
DELETE | | integration/api/odata/Projects({key}) | |
PATCH | | integration/api/odata/Projects({key}) | |
POST | | integration/api/odata/Projects({key}) | |
Projects Actions
|
Action | Required Permission(s) | Link | Description |
---|
AutoAllocateProject | WS-ModifyPredict,WS-ModifyBulkAutoAllocation | integration/api/odata/Projects({key})/AutoAllocateProject(ProjectJobAction={projectjobaction}) | Initiates the action of allocating the project. |
Projects Functions
|
Function | Required Permission(s) | Link | Description |
---|
GetAllProjectDependencies | WS-ReadPredict,WS-ReadBulkAutoAllocation | integration/api/odata/Projects/GetAllProjectDependencies(ProjectID={projectid}) | |
ListAllocateCriteria | WS-ReadPredict,WS-ReadBulkAutoAllocation | integration/api/odata/Projects/ListAllocateCriteria(ProjectID={projectid}) | |
GetCompletedItems | WS-ReadPredict,WS-ReadBulkAutoAllocation | integration/api/odata/Projects/GetCompletedItems(ProjectID={projectid}) | |
ListProjectGanttItems | WS-ReadPredict,WS-ReadBulkAutoAllocation | integration/api/odata/Projects/ListProjectGanttItems(StartDate={startdate}, EndDate={enddate}, ProjectType={projecttype}, ProjectStatuses={projectstatuses}) | |
HasProjectItems | WS-ReadPredict,WS-ReadBulkAutoAllocation | integration/api/odata/Projects/HasProjectItems(ProjectID={projectid}) | |
IsProjectValid | WS-ReadPredict,WS-ReadBulkAutoAllocation | integration/api/odata/Projects/IsProjectValid(ProjectID={projectid}, ProjectJobAction={projectjobaction}) | |
ListAllocateResults | WS-ReadPredict,WS-ReadBulkAutoAllocation | integration/api/odata/Projects/ListAllocateResults(ProjectID={projectid}) | |
ListRelatedAssets | WS-ReadPredict,WS-ReadBulkAutoAllocation | integration/api/odata/Projects/ListRelatedAssets(ProjectID={projectid}, AssetID={assetid}) | |
ListLinkedItems | WS-ReadPredict,WS-ReadBulkAutoAllocation | integration/api/odata/Projects/ListLinkedItems(ProjectID={projectid}) | |
ProjectAssetSearch | WS-ReadPredict,WS-ReadBulkAutoAllocation,WS-ReadServer,WS-ReadPDU,WS-ReadPowerstrip,WS-ReadCabinet,WS-ReadNetwork,WS-ReadPeripheral,WS-ReadKVMSwitch,WS-ReadAirConditioning,WS-ReadReceptacle,WS-ReadChassis,WS-ReadAuxiliary,WS-ReadStaticSwitch,WS-ReadUPS | integration/api/odata/Projects/ProjectAssetSearch(ProjectType={projecttype}, SearchTerm={searchterm}, RecordStatus={recordstatus}, OperationalStatus={operationalstatus}, MaterialType={materialtype}, LocationGroupID={locationgroupid}) | |
Projects Custom Routes
|
CustomRoute | Required Permission(s) | Supported Method(s) | Description |
---|
integration/api/odata/Projects | WS-ModifyPredict,WS-ModifyBulkAutoAllocation |
DELETE
| |
integration/api/odata/Projects({key})/ProjectItems | WS-ReadPredict,WS-ReadBulkAutoAllocation |
GET
| |
integration/api/odata/Projects({key})/ProjectItems({relatedKey}) | WS-ReadPredict,WS-ReadBulkAutoAllocation |
GET
| |
integration/api/odata/Projects({key})/ProjectItems | |
POST
| |
integration/api/odata/Projects({key})/ProjectItems({relatedKey}) | WS-ModifyPredict,WS-ModifyBulkAutoAllocation |
PATCH
| |
integration/api/odata/Projects({key})/ProjectItems({relatedKey}) | WS-ModifyPredict,WS-ModifyBulkAutoAllocation |
DELETE
| |
integration/api/odata/Projects({key})/ProjectItems | |
DELETE
| |
integration/api/odata/Projects({key})/ProjectItemAllocateCriterias | WS-ReadPredict,WS-ReadBulkAutoAllocation |
GET
| |
integration/api/odata/Projects({key})/ProjectItemAllocateCriterias({relatedKey}) | WS-ReadPredict,WS-ReadBulkAutoAllocation |
GET
| |
integration/api/odata/Projects({key})/ProjectItemAllocateCriterias({relatedKey}) | WS-ModifyPredict,WS-ModifyBulkAutoAllocation |
PATCH
| |
integration/api/odata/Projects({key})/ProjectDependencies | |
GET
| |
integration/api/odata/Projects({key})/ProjectDependencies({relatedKey}) | |
GET
| |
integration/api/odata/Projects({key})/ProjectDependencies | |
POST
| |
integration/api/odata/Projects({key})/ProjectDependencies({relatedKey}) | |
PATCH
| |
integration/api/odata/Projects({key})/ProjectDependencies({relatedKey}) | |
DELETE
| |
integration/api/odata/Projects({key})/ProjectDependencies | |
DELETE
| |
integration/api/odata/Projects({key})/ProjectDependents | |
GET
| |
integration/api/odata/Projects({key})/ProjectDependents({relatedKey}) | |
GET
| |
integration/api/odata/Projects/In(Ids={ids}) | |
GET
| |
integration/api/odata/Projects/NotIn(Ids={ids}) | |
GET
| |
Projects Nested Properties
|
NestedProperty | Supported Method(s) |
---|
ProjectItems |
POST
PATCH
|
ProjectItemAllocateCriterias | |
ProjectDependencies |
BIND
POST
PATCH
|
Verb(s) | Required Permission(s) | Link | Description |
---|
GET | | integration/api/odata/Providers({key}) | |
GET | | integration/api/odata/Providers | |
GET | | integration/api/odata/Providers({key}) | |
Providers Actions
No actions
Providers Functions
No functions
Providers Custom Routes
No custom routes
Providers Nested Properties
No nested properties
Verb(s) | Required Permission(s) | Link | Description |
---|
POST | WS-AddRealtimeDataProvider | integration/api/odata/RealTimeDataProviders | |
PATCH | WS-ModifyRealtimeDataProvider | integration/api/odata/RealTimeDataProviders({key}) | |
DELETE | WS-ModifyRealtimeDataProvider | integration/api/odata/RealTimeDataProviders({key}) | |
GET | WS-ReadRealtimeDataProvider | integration/api/odata/RealTimeDataProviders | |
GET | WS-ReadRealtimeDataProvider | integration/api/odata/RealTimeDataProviders({key}) | |
RealTimeDataProviders Actions
No actions
RealTimeDataProviders Functions
No functions
RealTimeDataProviders Custom Routes
|
CustomRoute | Required Permission(s) | Supported Method(s) | Description |
---|
integration/api/odata/Cultures/In(Ids={ids}) | |
GET
| |
integration/api/odata/Cultures/NotIn(Ids={ids}) | |
GET
| |
RealTimeDataProviders Nested Properties
No nested properties
Verb(s) | Required Permission(s) | Link | Description |
---|
POST | WS-AddRealtimeInfo | integration/api/odata/RealTimeInfo | |
PATCH | WS-ModifyRealtimeInfo | integration/api/odata/RealTimeInfo({key}) | |
DELETE | WS-ModifyRealtimeInfo | integration/api/odata/RealTimeInfo({key}) | |
GET | WS-ReadRealtimeInfo | integration/api/odata/RealTimeInfo | |
GET | WS-ReadRealtimeInfo | integration/api/odata/RealTimeInfo({key}) | |
RealTimeInfo Actions
No actions
RealTimeInfo Functions
No functions
RealTimeInfo Custom Routes
|
CustomRoute | Required Permission(s) | Supported Method(s) | Description |
---|
integration/api/odata/Cultures/In(Ids={ids}) | |
GET
| |
integration/api/odata/Cultures/NotIn(Ids={ids}) | |
GET
| |
RealTimeInfo Nested Properties
No nested properties
Verb(s) | Required Permission(s) | Link | Description |
---|
POST | WS-ModifyReceptacleMaterial | integration/api/odata/ReceptacleMaterials({key}) | |
POST | WS-AddReceptacleMaterial | integration/api/odata/ReceptacleMaterials | |
PATCH | WS-ModifyReceptacleMaterial | integration/api/odata/ReceptacleMaterials({key}) | |
DELETE | WS-ModifyReceptacleMaterial | integration/api/odata/ReceptacleMaterials({key}) | |
GET | WS-ReadReceptacleMaterial | integration/api/odata/ReceptacleMaterials | |
GET | WS-ReadReceptacleMaterial | integration/api/odata/ReceptacleMaterials({key}) | |
ReceptacleMaterials Actions
|
Action | Required Permission(s) | Link | Description |
---|
Cancel | WS-ModifyReceptacleMaterial | integration/api/odata/ReceptacleMaterials({key})/Cancel | |
Activate | WS-ModifyReceptacleMaterial | integration/api/odata/ReceptacleMaterials({key})/Activate | Function that will move a material in Active status. |
Deactivate | WS-ModifyReceptacleMaterial | integration/api/odata/ReceptacleMaterials({key})/Deactivate | Function that will move a material in Inactive status. |
UploadFile | WS-AddFile | integration/api/odata/ReceptacleMaterials({key})/UploadFile(File={file}) | |
DeleteFile | WS-ModifyFile | integration/api/odata/ReceptacleMaterials({key})/DeleteFile(FileName={filename}) | |
ReceptacleMaterials Functions
|
Function | Required Permission(s) | Link | Description |
---|
DownloadFile | WS-ReadFile | integration/api/odata/ReceptacleMaterials({key})/DownloadFile(FileName={filename}) | |
GetAuditLogData | WS-ReadAuditLog | integration/api/odata/ReceptacleMaterials({key})/GetAuditLogData | Function used to export all audit information for a specific entity. Please use the following Content-Type:application/vnd.openxmlformats-officedocument.spreadsheetml.sheet for file download |
ReceptacleMaterials Custom Routes
|
CustomRoute | Required Permission(s) | Supported Method(s) | Description |
---|
integration/api/odata/ReceptacleMaterials/In(Ids={ids}) | |
GET
| |
integration/api/odata/ReceptacleMaterials/NotIn(Ids={ids}) | |
GET
| |
integration/api/odata/ReceptacleMaterials({key})/Files | |
DELETE
| |
ReceptacleMaterials Nested Properties
No nested properties
Verb(s) | Required Permission(s) | Link | Description |
---|
POST | WS-ModifyReceptacle | integration/api/odata/Receptacles({key}) | |
POST | WS-AddReceptacle | integration/api/odata/Receptacles | |
PATCH | WS-ModifyReceptacle | integration/api/odata/Receptacles({key}) | |
DELETE | WS-ModifyReceptacle | integration/api/odata/Receptacles({key}) | |
GET | WS-ReadReceptacle | integration/api/odata/Receptacles | |
GET | WS-ReadReceptacle | integration/api/odata/Receptacles({key}) | |
Receptacles Actions
|
Action | Required Permission(s) | Link | Description |
---|
BeginMove | WS-PlanDecommissionReceptacle | integration/api/odata/Receptacles({key})/BeginMove(RelocateType={relocatetype}) | Function that is used to move the selected asset in a planned state, Moving, Recycling or Decommissioning, depending on the RelocateType provided as parameter. The response contains the Planned AssetId. |
CancelMove | WS-CancelDecommissionReceptacle | integration/api/odata/Receptacles({key})/CancelMove | Function that is used to cancel planned action. The selected asset will become Active/Operational. |
CompleteMove | WS-CompleteDecommissionReceptacle | integration/api/odata/Receptacles({key})/CompleteMove | Function that is used to finish planned action. The selected asset will become Active/Operational, Recycled/Available or Decommissioned/Decommissioned, depending on the Planned entity type (Move, Recycle or Deccommission). |
DirectMove | WS-SetLocationReceptacle | integration/api/odata/Receptacles({key})/DirectMove(RelocateType={relocatetype}, LocationGroupID={locationgroupid}) | Function that is used to directly move an asset to a new location in a final state. |
CompleteCreation | WS-ModifyReceptacle | integration/api/odata/Receptacles({key})/CompleteCreation | Function that moves an asset from Planned/(Pre)Procurement to Active/Operational. |
SetMaterial | WS-SetMaterialReceptacle | integration/api/odata/Receptacles({key})/SetMaterial(NewMaterialID={newmaterialid}) | Function that is used to change the material on an existing receptacle. The material for the selected receptacle is swapped with the new material by providing the NewMaterialID parameter in the BODY. The response contains the new AssetID of the receptacle after the material has been replaced. |
AddRealTimeValues | WS-AddAssetRealtimeData | integration/api/odata/Receptacles({key})/AddRealTimeValues(RealTimeInfo={realtimeinfo}, RealTimeValue={realtimevalue}) | Adds a provider specfic recorded real-time value against an asset or its associated outlet. Custom metrics are only allowed on assets whereas load, power and voltage metrics are allowed against assets, outlets or their relevant phases. |
AddNetworkAsset | WS-ReadNetworkConnection,WS-AddNetworkConnection | integration/api/odata/Receptacles({key})/AddNetworkAsset(NetworkAssetId={networkassetid}) | Function that is adding the selected asset in the list of available asset to be used in network connections. The mapping between the two assets is created by providing the NetworkAssetId parameter in the BODY, NetworkAssetId representing the AssetID of the asset to be added in the list of available assets. |
RemoveNetworkAsset | WS-ModifyNetworkConnection | integration/api/odata/Receptacles({key})/RemoveNetworkAsset(NetworkAssetId={networkassetid}, NetworkLinkerType={networklinkertype}) | Function that removes an asset from the association list of available asset to be used in network connections. |
UploadFile | WS-AddFile | integration/api/odata/Receptacles({key})/UploadFile(File={file}) | |
DeleteFile | WS-ModifyFile | integration/api/odata/Receptacles({key})/DeleteFile(FileName={filename}) | |
Receptacles Functions
|
Function | Required Permission(s) | Link | Description |
---|
GetTotalSystemPowerConsumption | WS-ReadReceptacle | integration/api/odata/Receptacles({key})/GetTotalSystemPowerConsumption | Function that returns the TotalSystemPowerConsumption for the selected asset. |
GetRealTimePowerInfo | WS-ReadReceptacle | integration/api/odata/Receptacles({key})/GetRealTimePowerInfo | |
GetDiscoveryAssetPage | WS-ReadReceptacle | integration/api/odata/Receptacles({key})/GetDiscoveryAssetPage | Function that returns a collection of entities of type Nlyte.Model.AssetMapping. Used to determine external providers. |
RecordModifiedInfo | WS-ReadReceptacle | integration/api/odata/Receptacles({key})/RecordModifiedInfo | Function that returns an entity of type Nlyte.Model.AuditLogInfo and provides information regarding last modifications against the current asset |
GetMountedChildAssets | | integration/api/odata/Receptacles({key})/GetMountedChildAssets(IncludeHosts={includehosts}, IncludeCards={includecards}) | Function that returns a collection of entities of type Nlyte.Model.MountedAssetSummary representing the list of mounted assets in the provided asset. The function is called as follows: Assets(AssetID)/GetMountedChildAssets(IncludeHosts=true,IncludeCards=true) where AssetID is the parent for which the children are retrieved. |
GetDistributorsWithFreeOutlets | WS-ReadAssetToAssetMapping | integration/api/odata/Receptacles({key})/GetDistributorsWithFreeOutlets(SearchTerm={searchterm}, SearchTermOption={searchtermoption}, LocationDepth={locationdepth}, MaterialTypeID={materialtypeid}, MaterialSubtypeID={materialsubtypeid}) | Function that returns a collection of entities of type Nlyte.Model.Distributor representing available power suppliers. |
SearchAssetNetworkPortLinkage | WS-ReadNetworkConnection | integration/api/odata/Receptacles({key})/SearchAssetNetworkPortLinkage(SearchTerm={searchterm}, SearchTermOption={searchtermoption}, CabinetMountingStatus={cabinetmountingstatus}, LocationTarget={locationtarget}, NetworkTypes={networktypes}, PortLocation={portlocation}) | Function that returns a collection of entities of type Nlyte.Model.AssetNetworkPortLinkage representing available assets to be used in network connections. |
GetRealTimeValues | WS-ReadAssetRealtimeData | integration/api/odata/Receptacles({key})/GetRealTimeValues | Function that returns a collection of entities of type Nlyte.Model.RealTimeValue. |
GetAssetSummaries | | integration/api/odata/Receptacles({key})/GetAssetSummaries(OwnedPeripherals={ownedperipherals}, IncludeHosts={includehosts}) | |
ListPowerConsumers | | integration/api/odata/Receptacles({key})/ListPowerConsumers | Function that returns a collection of Nlyte.Model.Graph entities. Used to identify available Output Connector used in power connections. |
SupportsPlannedMove | | integration/api/odata/Receptacles({key})/SupportsPlannedMove | |
GetTotalSystemWeight | | integration/api/odata/Receptacles({key})/GetTotalSystemWeight | Function that returns the TotalSystemWeight for the selected asset. |
GetMountedOnAssetID | | integration/api/odata/Receptacles({key})/GetMountedOnAssetID | |
GetAssetsReportData | WS-ReadNetwork,WS-ReadCabinet,WS-ReadPeripheral,WS-ReadKVMSwitch,WS-ReadServer,WS-ReadPDU,WS-ReadPowerStrip,WS-ReadAirConditioning,WS-ReadReceptacle,WS-ReadChassis,WS-ReadUPS,WS-ReadAuxiliary,WS-ReadStaticSwitch,WS-ReadServerHost | integration/api/odata/Receptacles/GetAssetsReportData(assetIds={assetids}) | |
DownloadFile | WS-ReadFile | integration/api/odata/Receptacles({key})/DownloadFile(FileName={filename}) | |
GetAuditLogData | WS-ReadAuditLog | integration/api/odata/Receptacles({key})/GetAuditLogData | Function used to export all audit information for a specific entity. Please use the following Content-Type:application/vnd.openxmlformats-officedocument.spreadsheetml.sheet for file download |
Receptacles Custom Routes
|
CustomRoute | Required Permission(s) | Supported Method(s) | Description |
---|
integration/api/odata/Receptacles({key})/Wires | |
GET
| |
integration/api/odata/Receptacles({key})/Notes({relatedKey}) | |
GET
| |
integration/api/odata/Receptacles({key})/Notes | |
GET
| |
integration/api/odata/Receptacles({key})/Notes | |
POST
| |
integration/api/odata/Receptacles({key})/Notes | |
DELETE
| |
integration/api/odata/Receptacles({key})/Notes({relatedKey}) | |
DELETE
| |
integration/api/odata/Receptacles({key})/Notes({relatedKey}) | |
PATCH
| |
integration/api/odata/Receptacles({key})/Utilities | |
GET
| |
integration/api/odata/Receptacles({key})/Utilities({relatedKey}) | |
GET
| |
integration/api/odata/Receptacles({key})/Utilities({relatedKey}) | |
DELETE
| |
integration/api/odata/Receptacles({key})/Graphs | |
GET
| |
integration/api/odata/Receptacles({key})/Graphs({relatedKey}) | |
GET
| |
integration/api/odata/Receptacles({key})/Graphs({relatedKey}) | |
PATCH
| |
integration/api/odata/Receptacles({key})/Graphs | |
POST
| |
integration/api/odata/Receptacles({key})/Graphs({relatedKey}) | |
DELETE
| |
integration/api/odata/Receptacles({key})/GetAvailableCabinetUs(CabinetID={cabinetId}) | WS-ReadCabinet |
GET
| |
integration/api/odata/Receptacles({key})/GetServiceRequests | |
GET
| |
integration/api/odata/Receptacles({key})/CustomFields | WS-ReadCustomFieldReceptacle |
GET
| |
integration/api/odata/Receptacles({key})/CustomFields | WS-ModifyCustomFieldReceptacle |
POST
| |
integration/api/odata/Receptacles({key})/CustomFields({relatedKey}) | WS-ModifyCustomFieldReceptacle |
PATCH
| |
integration/api/odata/Receptacles({key})/CustomFields({relatedKey}) | WS-ModifyCustomFieldReceptacle |
DELETE
| |
integration/api/odata/Receptacles({key})/Warranty | WS-ReadReceptacle |
GET
| |
integration/api/odata/Receptacles({key})/Warranty | WS-ModifyReceptacle |
POST
| |
integration/api/odata/Receptacles({key})/Warranty | WS-ModifyReceptacle |
PATCH
| |
integration/api/odata/Receptacles({key})/Warranty | WS-ModifyReceptacle |
DELETE
| |
integration/api/odata/Receptacles({key})/Maintenance | WS-ReadReceptacle |
GET
| |
integration/api/odata/Receptacles({key})/Maintenance | WS-ModifyReceptacle |
POST
| |
integration/api/odata/Receptacles({key})/Maintenance | WS-ModifyReceptacle |
PATCH
| |
integration/api/odata/Receptacles({key})/Maintenance | WS-ModifyReceptacle |
DELETE
| |
integration/api/odata/Receptacles({key})/AssetMounting | |
GET
| |
integration/api/odata/Receptacles({key})/Ownership | WS-ReadBusinessGroupAssetMap |
GET
| |
integration/api/odata/Receptacles({key})/Ownership({relatedKey}) | WS-ReadBusinessGroupAssetMap |
GET
| |
integration/api/odata/Receptacles({key})/Ownership | WS-AddBusinessGroupAssetMap |
POST
| |
integration/api/odata/Receptacles({key})/Ownership({relatedKey}) | WS-ModifyBusinessGroupAssetMap |
PATCH
| |
integration/api/odata/Receptacles({key})/Ownership({relatedKey}) | WS-ModifyBusinessGroupAssetMap |
DELETE
| |
integration/api/odata/Receptacles({key})/Support | WS-ReadSupportGroupAssetMap |
GET
| |
integration/api/odata/Receptacles({key})/Support({relatedKey}) | WS-ReadSupportGroupAssetMap |
GET
| |
integration/api/odata/Receptacles({key})/Support | WS-AddSupportGroupAssetMap |
POST
| |
integration/api/odata/Receptacles({key})/Support({relatedKey}) | WS-ModifySupportGroupAssetMap |
PATCH
| |
integration/api/odata/Receptacles({key})/Support({relatedKey}) | WS-ModifySupportGroupAssetMap |
DELETE
| |
integration/api/odata/Receptacles({key})/AssociatedAssets({relatedKey}) | |
DELETE
| |
integration/api/odata/Receptacles({key})/AssociatedAssets({relatedKey})/Notes({nestedRelatedKey}) | |
GET
| |
integration/api/odata/Receptacles({key})/AssociatedAssets({relatedKey})/Notes | |
GET
| |
integration/api/odata/Receptacles({key})/AssociatedAssets({relatedKey})/Notes({nestedRelatedKey}) | |
PATCH
| |
integration/api/odata/Receptacles({key})/AssociatedAssets({relatedKey})/Notes | |
POST
| |
integration/api/odata/Receptacles({key})/AssociatedAssets({relatedKey})/Notes | |
DELETE
| |
integration/api/odata/Receptacles({key})/AssociatedAssets({relatedKey})/Notes({nestedRelatedKey}) | |
DELETE
| |
integration/api/odata/Receptacles/In(Ids={ids}) | |
GET
| |
integration/api/odata/Receptacles/NotIn(Ids={ids}) | |
GET
| |
integration/api/odata/Receptacles({key})/Files | |
DELETE
| |
Receptacles Nested Properties
|
NestedProperty | Supported Method(s) |
---|
Ownership |
BIND
POST
PATCH
|
Support |
BIND
POST
PATCH
|
CustomFields |
POST
PATCH
|
Maintenance |
POST
PATCH
|
Warranty |
POST
PATCH
|
AssetIPAddressMap |
POST
PATCH
|
LocationGroup | |
AssociatedAssets |
BIND
|
Utilities |
POST
PATCH
|
Graphs |
POST
PATCH
|
UMounting |
POST
PATCH
|
OutputConnectors |
PATCH
|
Verb(s) | Required Permission(s) | Link | Description |
---|
GET | | integration/api/odata/RecordTypes | |
GET | | integration/api/odata/RecordTypes({key}) | |
RecordTypes Actions
No actions
RecordTypes Functions
No functions
RecordTypes Custom Routes
|
CustomRoute | Required Permission(s) | Supported Method(s) | Description |
---|
integration/api/odata/RecordTypes/In(Ids={ids}) | |
GET
| |
integration/api/odata/RecordTypes/NotIn(Ids={ids}) | |
GET
| |
RecordTypes Nested Properties
No nested properties
Verb(s) | Required Permission(s) | Link | Description |
---|
POST | WS-AddForm | integration/api/odata/ReportingTags | |
GET | | integration/api/odata/ReportingTags | |
GET | | integration/api/odata/ReportingTags({key}) | |
ReportingTags Actions
No actions
ReportingTags Functions
No functions
ReportingTags Custom Routes
|
CustomRoute | Required Permission(s) | Supported Method(s) | Description |
---|
integration/api/odata/ReportingTags/In(Ids={ids}) | |
GET
| |
integration/api/odata/ReportingTags/NotIn(Ids={ids}) | |
GET
| |
ReportingTags Nested Properties
No nested properties
Verb(s) | Required Permission(s) | Link | Description |
---|
GET | | integration/api/odata/Resources | |
GET | | integration/api/odata/Resources({key}) | |
Resources Actions
No actions
Resources Functions
No functions
Resources Custom Routes
|
CustomRoute | Required Permission(s) | Supported Method(s) | Description |
---|
integration/api/odata/Resources/In(Ids={ids}) | |
GET
| |
integration/api/odata/Resources/NotIn(Ids={ids}) | |
GET
| |
Resources Nested Properties
No nested properties
Verb(s) | Required Permission(s) | Link | Description |
---|
GET | WS-ReadRoomPlan | integration/api/odata/Rooms | |
PUT | WS-ModifyRoomPlan | integration/api/odata/Rooms({key}) | |
GET | WS-ReadRoomPlan | integration/api/odata/Rooms({key}) | |
Rooms Actions
No actions
Rooms Functions
|
Function | Required Permission(s) | Link | Description |
---|
GetRoomAssetPanelSummary | WS-ReadRoomPlan | integration/api/odata/Rooms({key})/GetRoomAssetPanelSummary | |
GetLocationWeight | WS-ReadRoomPlan | integration/api/odata/Rooms({key})/GetLocationWeight | |
LoadRoom | WS-ReadRoomPlan | integration/api/odata/Rooms/LoadRoom(roomLocationGroupId={roomlocationgroupid}) | |
Rooms Custom Routes
|
CustomRoute | Required Permission(s) | Supported Method(s) | Description |
---|
integration/api/odata/GetRoomItemAssets(locationGroupId={locationGroupId}, assetIds={assetIds}) | WS-ReadRoomPlan |
GET
| |
integration/api/odata/GetPowerStatistics(LocationGroupId={LocationGroupId}) | WS-ReadRoomPlan, WS-ReadFloorPlan |
GET
| |
integration/api/odata/GetCoolingStatistics(LocationGroupId={LocationGroupId}) | WS-ReadRoomPlan, WS-ReadFloorPlan |
GET
| |
integration/api/odata/GetFloorSpaceStatisticsForFloor(locationGroupId={LocationGroupId}) | WS-ReadFloorPlan |
GET
| |
integration/api/odata/GetFloorSpaceStatisticsForArea(areaID={AreaID}) | WS-ReadRoomPlan |
GET
| |
integration/api/odata/GetFloorSpaceStatisticsForRoom(locationGroupId={LocationGroupId}) | WS-ReadRoomPlan |
GET
| |
integration/api/odata/GetUnplacedAssets(locationGroupId={LocationGroupId}) | WS-ReadRoomPlan |
GET
| |
Rooms Nested Properties
No nested properties
Verb(s) | Required Permission(s) | Link | Description |
---|
POST | WS-AddPDUMaterial | integration/api/odata/RPPPDUMaterials | |
PATCH | WS-ModifyPDUMaterial | integration/api/odata/RPPPDUMaterials({key}) | |
DELETE | WS-ModifyPDUMaterial | integration/api/odata/RPPPDUMaterials({key}) | |
GET | WS-ReadPDUMaterial | integration/api/odata/RPPPDUMaterials | |
GET | WS-ReadPDUMaterial | integration/api/odata/RPPPDUMaterials({key}) | |
RPPPDUMaterials Actions
|
Action | Required Permission(s) | Link | Description |
---|
Cancel | WS-ModifyPDUMaterial | integration/api/odata/RPPPDUMaterials({key})/Cancel | |
Activate | WS-ModifyPDUMaterial | integration/api/odata/RPPPDUMaterials({key})/Activate | Function that will move a material in Active status. |
Deactivate | WS-ModifyPDUMaterial | integration/api/odata/RPPPDUMaterials({key})/Deactivate | Function that will move a material in Inactive status. |
UploadFile | WS-AddFile | integration/api/odata/RPPPDUMaterials({key})/UploadFile(File={file}) | |
DeleteFile | WS-ModifyFile | integration/api/odata/RPPPDUMaterials({key})/DeleteFile(FileName={filename}) | |
RPPPDUMaterials Functions
|
Function | Required Permission(s) | Link | Description |
---|
DownloadFile | WS-ReadFile | integration/api/odata/RPPPDUMaterials({key})/DownloadFile(FileName={filename}) | |
GetAuditLogData | WS-ReadAuditLog | integration/api/odata/RPPPDUMaterials({key})/GetAuditLogData | Function used to export all audit information for a specific entity. Please use the following Content-Type:application/vnd.openxmlformats-officedocument.spreadsheetml.sheet for file download |
RPPPDUMaterials Custom Routes
|
CustomRoute | Required Permission(s) | Supported Method(s) | Description |
---|
integration/api/odata/RPPPDUMaterials({key})/Files | |
DELETE
| |
RPPPDUMaterials Nested Properties
No nested properties
Verb(s) | Required Permission(s) | Link | Description |
---|
GET | | integration/api/odata/SchemeColours | |
GET | | integration/api/odata/SchemeColours({key}) | |
SchemeColours Actions
No actions
SchemeColours Functions
No functions
SchemeColours Custom Routes
No custom routes
SchemeColours Nested Properties
No nested properties
Verb(s) | Required Permission(s) | Link | Description |
---|
POST | | integration/api/odata/Search | |
Search Actions
No actions
Search Functions
No functions
Search Custom Routes
|
CustomRoute | Required Permission(s) | Supported Method(s) | Description |
---|
integration/api/odata/GetAvailableSearchCriteria | |
GET
| |
integration/api/odata/GetMaxAnyAllExpressionDepth | |
GET
| |
Search Nested Properties
No nested properties
Verb(s) | Required Permission(s) | Link | Description |
---|
POST | WS-ModifyServerHost | integration/api/odata/ServerHosts({key}) | |
POST | WS-AddServerHost | integration/api/odata/ServerHosts | |
DELETE | WS-ModifyServerHost | integration/api/odata/ServerHosts({key}) | |
PATCH | WS-ModifyServerHost | integration/api/odata/ServerHosts({key}) | |
GET | WS-ReadServerHost | integration/api/odata/ServerHosts | |
GET | WS-ReadServerHost | integration/api/odata/ServerHosts({key}) | |
ServerHosts Actions
|
Action | Required Permission(s) | Link | Description |
---|
UpdateBusinessApplication | | integration/api/odata/ServerHosts({key})/UpdateBusinessApplication(BusinessApplicationID={businessapplicationid}, Percentage={percentage}) | |
BeginMove | WS-PlanMoveHost, WS-PlanDecommissionHost | integration/api/odata/ServerHosts({key})/BeginMove(RelocateType={relocatetype}) | |
Move | WS-SetLocationHost | integration/api/odata/ServerHosts({key})/Move(ServerId={serverid}) | |
CancelMove | WS-CancelMoveHost, WS-CancelDecommissionHost | integration/api/odata/ServerHosts({key})/CancelMove | |
CompleteMove | WS-CompleteMoveHost, WS-CompleteDecommissionHost | integration/api/odata/ServerHosts({key})/CompleteMove | |
UploadFile | WS-AddFile | integration/api/odata/ServerHosts({key})/UploadFile(File={file}) | |
DeleteFile | WS-ModifyFile | integration/api/odata/ServerHosts({key})/DeleteFile(FileName={filename}) | |
ServerHosts Functions
|
Function | Required Permission(s) | Link | Description |
---|
GetConventionSets | | integration/api/odata/ServerHosts/GetConventionSets(EntityTypeID={entitytypeid}) | |
GetConventions | | integration/api/odata/ServerHosts/GetConventions(ConventionSetID={conventionsetid}) | |
GenerateConventionName | | integration/api/odata/ServerHosts/GenerateConventionName(ConventionID={conventionid}) | |
RecordModifiedInfo | WS-ReadServerHost | integration/api/odata/ServerHosts({key})/RecordModifiedInfo | Function that returns an entity of type Nlyte.Model.AuditLogInfo and provides information regarding last modifications against the current asset |
GetDiscoveryHostPage | WS-ReadServerHost | integration/api/odata/ServerHosts({key})/GetDiscoveryHostPage | Function that returns a collection of entities of type Nlyte.Model.HostMapping. Used to determine external providers. |
DownloadFile | WS-ReadFile | integration/api/odata/ServerHosts({key})/DownloadFile(FileName={filename}) | |
GetConventionSets | | integration/api/odata/ServerHosts/GetConventionSets(EntityTypeID={entitytypeid}) | |
GetConventions | | integration/api/odata/ServerHosts/GetConventions(ConventionSetID={conventionsetid}) | |
GenerateConventionName | | integration/api/odata/ServerHosts/GenerateConventionName(ConventionID={conventionid}) | |
ServerHosts Custom Routes
|
CustomRoute | Required Permission(s) | Supported Method(s) | Description |
---|
integration/api/odata/ServerHosts({key})/Ownership | WS-AddServerHostBusinessGroupMap |
POST
| |
integration/api/odata/ServerHosts({key})/Support | WS-AddServerHostSupportGroupMap |
POST
| |
integration/api/odata/ServerHosts({key})/Ownership({relatedKey}) | WS-ModifyServerHostBusinessGroupMap |
PATCH
| |
integration/api/odata/ServerHosts({key})/Support({relatedKey}) | WS-ModifyServerHostSupportGroupMap |
PATCH
| |
integration/api/odata/ServerHosts | |
POST
| |
integration/api/odata/ServerHosts | |
DELETE
| |
integration/api/odata/ServerHosts | |
POST
| |
integration/api/odata/ServerHosts({key})/Ownership | WS-ModifyServerHostBusinessGroupMap |
DELETE
| |
integration/api/odata/ServerHosts({key})/Ownership({relatedKey}) | WS-ModifyServerHostBusinessGroupMap |
DELETE
| |
integration/api/odata/ServerHosts({key})/Ownership | WS-ReadServerHostBusinessGroupMap |
GET
| |
integration/api/odata/ServerHosts({key})/Ownership({relatedKey}) | WS-ReadServerHostBusinessGroupMap |
GET
| |
integration/api/odata/ServerHosts({key})/Support | WS-ModifyServerHostSupportGroupMap |
DELETE
| |
integration/api/odata/ServerHosts({key})/Support({relatedKey}) | WS-ModifyServerHostSupportGroupMap |
DELETE
| |
integration/api/odata/ServerHosts({key})/Support | WS-ReadServerHostSupportGroupMap |
GET
| |
integration/api/odata/ServerHosts({key})/Support({relatedKey}) | WS-ReadServerHostSupportGroupMap |
GET
| |
integration/api/odata/ServerHosts({key})/BusinessApplicationServerHosts | WS-ModifyBusinessApplication |
DELETE
| |
integration/api/odata/ServerHosts({key})/BusinessApplicationServerHosts({relatedKey}) | WS-ModifyBusinessApplication |
DELETE
| |
integration/api/odata/ServerHosts({key})/ServerHostSoftwares | |
DELETE
| |
integration/api/odata/ServerHosts({key})/ServerHostSoftwares({relatedKey}) | |
DELETE
| |
integration/api/odata/ServerHosts({key})/ServerHostIPAddresses | |
DELETE
| |
integration/api/odata/ServerHosts({key})/ServerHostIPAddresses({relatedKey}) | |
DELETE
| |
integration/api/odata/ServerHosts({key})/Notes({relatedKey}) | |
GET
| |
integration/api/odata/ServerHosts({key})/Notes | |
GET
| |
integration/api/odata/ServerHosts({key})/Notes | |
POST
| |
integration/api/odata/ServerHosts({key})/Notes | |
DELETE
| |
integration/api/odata/ServerHosts({key})/Notes({relatedKey}) | |
DELETE
| |
integration/api/odata/ServerHosts({key})/Notes({relatedKey}) | |
PATCH
| |
integration/api/odata/ServerHosts({key})/GetServiceRequests | |
GET
| Function that returns a collection of Nlyte.Model.ServiceRequest entities representing the service requests having tasks using the selected host. |
integration/api/odata/ServerHosts({key})/AssetMounting | |
GET
| |
integration/api/odata/ServerHosts({key})/InternalEquipmentItemUtilisations({relatedKey})/Notes({nestedRelatedKey}) | |
GET
| |
integration/api/odata/ServerHosts({key})/InternalEquipmentItemUtilisations({relatedKey})/Notes | |
GET
| |
integration/api/odata/ServerHosts({key})/InternalEquipmentItemUtilisations({relatedKey})/Notes | |
POST
| |
integration/api/odata/ServerHosts({key})/InternalEquipmentItemUtilisations({relatedKey})/Notes | |
DELETE
| |
integration/api/odata/ServerHosts({key})/InternalEquipmentItemUtilisations({relatedKey})/Notes({nestedRelatedKey}) | |
DELETE
| |
integration/api/odata/ServerHosts({key})/InternalEquipmentItemUtilisations({relatedKey})/Notes({nestedRelatedKey}) | |
PATCH
| |
integration/api/odata/ServerHosts | |
GET
| |
integration/api/odata/ServerHosts({key})/Files | |
DELETE
| |
integration/api/odata/ServerHosts({key})/InternalEquipmentItemUtilisations | |
POST
| |
integration/api/odata/ServerHosts({key})/InternalEquipmentItemUtilisations | |
PATCH
| |
integration/api/odata/ServerHosts({key})/InternalEquipmentItemUtilisations({relatedKey}) | |
DELETE
| |
integration/api/odata/ServerHosts/In(Ids={ids}) | |
GET
| |
integration/api/odata/ServerHosts/NotIn(Ids={ids}) | |
GET
| |
ServerHosts Nested Properties
|
NestedProperty | Supported Method(s) |
---|
InternalEquipmentItemUtilisations |
POST
PATCH
|
Ownership |
BIND
POST
PATCH
|
Support |
BIND
POST
PATCH
|
BusinessApplicationServerHosts |
BIND
POST
PATCH
|
ServerHostSoftwares |
BIND
POST
PATCH
|
ServerHostIPAddresses |
BIND
POST
PATCH
|
Verb(s) | Required Permission(s) | Link | Description |
---|
POST | WS-ModifyServerMaterial | integration/api/odata/ServerMaterials({key}) | |
POST | WS-AddServerMaterial | integration/api/odata/ServerMaterials | |
PATCH | WS-ModifyServerMaterial | integration/api/odata/ServerMaterials({key}) | |
DELETE | WS-ModifyServerMaterial | integration/api/odata/ServerMaterials({key}) | |
GET | WS-ReadServerMaterial | integration/api/odata/ServerMaterials | |
GET | WS-ReadServerMaterial | integration/api/odata/ServerMaterials({key}) | |
ServerMaterials Actions
|
Action | Required Permission(s) | Link | Description |
---|
Cancel | WS-ModifyServerMaterial | integration/api/odata/ServerMaterials({key})/Cancel | |
Activate | WS-ModifyServerMaterial | integration/api/odata/ServerMaterials({key})/Activate | Function that will move a material in Active status. |
Deactivate | WS-ModifyServerMaterial | integration/api/odata/ServerMaterials({key})/Deactivate | Function that will move a material in Inactive status. |
UploadFile | WS-AddFile | integration/api/odata/ServerMaterials({key})/UploadFile(File={file}) | |
DeleteFile | WS-ModifyFile | integration/api/odata/ServerMaterials({key})/DeleteFile(FileName={filename}) | |
ServerMaterials Functions
|
Function | Required Permission(s) | Link | Description |
---|
DownloadFile | WS-ReadFile | integration/api/odata/ServerMaterials({key})/DownloadFile(FileName={filename}) | |
GetAuditLogData | WS-ReadAuditLog | integration/api/odata/ServerMaterials({key})/GetAuditLogData | Function used to export all audit information for a specific entity. Please use the following Content-Type:application/vnd.openxmlformats-officedocument.spreadsheetml.sheet for file download |
ServerMaterials Custom Routes
|
CustomRoute | Required Permission(s) | Supported Method(s) | Description |
---|
integration/api/odata/ServerMaterials/In(Ids={ids}) | |
GET
| |
integration/api/odata/ServerMaterials/NotIn(Ids={ids}) | |
GET
| |
integration/api/odata/ServerMaterials({key})/Files | |
DELETE
| |
ServerMaterials Nested Properties
No nested properties
Verb(s) | Required Permission(s) | Link | Description |
---|
GET | WS-ReadServer | integration/api/odata/Servers | |
PATCH | WS-ModifyServer | integration/api/odata/Servers({key}) | |
POST | WS-AddServer | integration/api/odata/Servers | |
POST | WS-ModifyServer | integration/api/odata/Servers({key}) | |
DELETE | WS-ModifyServer | integration/api/odata/Servers({key}) | |
GET | WS-ReadServer | integration/api/odata/Servers({key}) | |
Servers Actions
|
Action | Required Permission(s) | Link | Description |
---|
BeginMove | WS-PlanMoveServer, WS-PlanRecycleServer, WS-PlanDecommissionServer | integration/api/odata/Servers({key})/BeginMove(RelocateType={relocatetype}) | Function that is used to move the selected asset in a planned state, Moving, Recycling or Decommissioning, depending on the RelocateType provided as parameter. The response contains the Planned AssetId. |
CancelMove | WS-CancelMoveServer, WS-CancelRecycleServer, WS-CancelDecommissionServer | integration/api/odata/Servers({key})/CancelMove | Function that is used to cancel planned action. The selected asset will become Active/Operational. |
CompleteMove | WS-CompleteMoveServer, WS-CompleteRecycleServer, WS-CompleteDecommissionServer | integration/api/odata/Servers({key})/CompleteMove | Function that is used to finish planned action. The selected asset will become Active/Operational, Recycled/Available or Decommissioned/Decommissioned, depending on the Planned entity type (Move, Recycle or Deccommission). |
DirectMove | WS-SetLocationServer | integration/api/odata/Servers({key})/DirectMove(RelocateType={relocatetype}, LocationGroupID={locationgroupid}) | Function that is used to directly move an asset to a new location in a final state. |
CompleteCreation | WS-ModifyServer | integration/api/odata/Servers({key})/CompleteCreation | Function that moves an asset from Planned/(Pre)Procurement to Active/Operational. |
SetMaterial | | integration/api/odata/Servers({key})/SetMaterial(NewMaterialID={newmaterialid}) | Function that is used to change the material on an existing asset. This action is only supported for Receptacles and Power Strips. |
AddRealTimeValues | WS-AddAssetRealtimeData | integration/api/odata/Servers({key})/AddRealTimeValues(RealTimeInfo={realtimeinfo}, RealTimeValue={realtimevalue}) | Adds a provider specfic recorded real-time value against an asset or its associated outlet. Custom metrics are only allowed on assets whereas load, power and voltage metrics are allowed against assets, outlets or their relevant phases. |
AddNetworkAsset | WS-ReadNetworkConnection,WS-AddNetworkConnection | integration/api/odata/Servers({key})/AddNetworkAsset(NetworkAssetId={networkassetid}) | Function that is adding the selected asset in the list of available asset to be used in network connections. The mapping between the two assets is created by providing the NetworkAssetId parameter in the BODY, NetworkAssetId representing the AssetID of the asset to be added in the list of available assets. |
RemoveNetworkAsset | WS-ModifyNetworkConnection | integration/api/odata/Servers({key})/RemoveNetworkAsset(NetworkAssetId={networkassetid}, NetworkLinkerType={networklinkertype}) | Function that removes an asset from the association list of available asset to be used in network connections. |
UploadFile | WS-AddFile | integration/api/odata/Servers({key})/UploadFile(File={file}) | |
DeleteFile | WS-ModifyFile | integration/api/odata/Servers({key})/DeleteFile(FileName={filename}) | |
Servers Functions
|
Function | Required Permission(s) | Link | Description |
---|
ListLinkedRecords | | integration/api/odata/Servers/ListLinkedRecords(assetIds={assetids}) | Retrieves a collection of assets, associated to the selected asset that will be affected by a potential move action. |
GetTotalSystemPowerConsumption | WS-ReadServer | integration/api/odata/Servers({key})/GetTotalSystemPowerConsumption | Function that returns the TotalSystemPowerConsumption for the selected asset. |
GetAssetAllocationCriteria | WS-ReadServer | integration/api/odata/Servers({key})/GetAssetAllocationCriteria | Used to retrieve Nlyte.Model.AssetAllocationCriteria representing the available allocation criteria used in auto-allocation. |
GetRealTimePowerInfo | WS-ReadServer | integration/api/odata/Servers({key})/GetRealTimePowerInfo | |
GetDiscoveryAssetPage | WS-ReadServer | integration/api/odata/Servers({key})/GetDiscoveryAssetPage | Function that returns a collection of entities of type Nlyte.Model.AssetMapping. Used to determine external providers. |
RecordModifiedInfo | WS-ReadServer | integration/api/odata/Servers({key})/RecordModifiedInfo | Function that returns an entity of type Nlyte.Model.AuditLogInfo and provides information regarding last modifications against the current asset |
GetChassisWithFreeSlots | WS-ReadChassis | integration/api/odata/Servers({key})/GetChassisWithFreeSlots(SearchTerm={searchterm}, SearchTermOption={searchtermoption}, OrientationID={orientationid}) | Returns a collection of entities of type Nlyte.Model.ChassisWithFreeSlots representing chassis assets with free slots available. |
GetMountedChildAssets | | integration/api/odata/Servers({key})/GetMountedChildAssets(IncludeHosts={includehosts}, IncludeCards={includecards}) | Function that returns a collection of entities of type Nlyte.Model.MountedAssetSummary representing the list of mounted assets in the provided asset. The function is called as follows: Assets(AssetID)/GetMountedChildAssets(IncludeHosts=true,IncludeCards=true) where AssetID is the parent for which the children are retrieved. |
GetDistributorsWithFreeOutlets | WS-ReadAssetToAssetMapping | integration/api/odata/Servers({key})/GetDistributorsWithFreeOutlets(SearchTerm={searchterm}, SearchTermOption={searchtermoption}, LocationDepth={locationdepth}, MaterialTypeID={materialtypeid}, MaterialSubtypeID={materialsubtypeid}) | Function that returns a collection of entities of type Nlyte.Model.Distributor representing available power suppliers. |
SearchAssetNetworkPortLinkage | WS-ReadNetworkConnection | integration/api/odata/Servers({key})/SearchAssetNetworkPortLinkage(SearchTerm={searchterm}, SearchTermOption={searchtermoption}, CabinetMountingStatus={cabinetmountingstatus}, LocationTarget={locationtarget}, NetworkTypes={networktypes}, PortLocation={portlocation}) | Function that returns a collection of entities of type Nlyte.Model.AssetNetworkPortLinkage representing available assets to be used in network connections. |
GetRealTimeValues | WS-ReadAssetRealtimeData | integration/api/odata/Servers({key})/GetRealTimeValues | Function that returns a collection of entities of type Nlyte.Model.RealTimeValue. |
GetAssetSummaries | | integration/api/odata/Servers({key})/GetAssetSummaries(OwnedPeripherals={ownedperipherals}, IncludeHosts={includehosts}) | |
GetNetworkCardPortsInfo | WS-ReadNetworkConnection | integration/api/odata/Servers({key})/GetNetworkCardPortsInfo | Returns an object of type Nlyte.Model.NetworkResults having information about Copper and Fiber Ports |
GetNetworkCardPortConnections | WS-ReadNetworkConnection | integration/api/odata/Servers({key})/GetNetworkCardPortConnections | Returns an object of type Nlyte.Model.NetworkResults having information about Copper and Fiber Port connections |
GetNetworkAssetSummary | WS-ReadNetworkConnection | integration/api/odata/Servers({key})/GetNetworkAssetSummary | Returns an object of type Nlyte.Model.NetworkResults having information about the networkable assets. |
ListPowerConsumers | | integration/api/odata/Servers({key})/ListPowerConsumers | Function that returns a collection of Nlyte.Model.Graph entities. Used to identify available Output Connector used in power connections. |
SupportsPlannedMove | | integration/api/odata/Servers({key})/SupportsPlannedMove | |
GetTotalSystemWeight | | integration/api/odata/Servers({key})/GetTotalSystemWeight | Function that returns the TotalSystemWeight for the selected asset. |
GetMountedOnAssetID | | integration/api/odata/Servers({key})/GetMountedOnAssetID | |
GetAssetsReportData | WS-ReadNetwork,WS-ReadCabinet,WS-ReadPeripheral,WS-ReadKVMSwitch,WS-ReadServer,WS-ReadPDU,WS-ReadPowerStrip,WS-ReadAirConditioning,WS-ReadReceptacle,WS-ReadChassis,WS-ReadUPS,WS-ReadAuxiliary,WS-ReadStaticSwitch,WS-ReadServerHost | integration/api/odata/Servers/GetAssetsReportData(assetIds={assetids}) | |
GetConventionSets | | integration/api/odata/Servers/GetConventionSets(EntityTypeID={entitytypeid}) | |
GetConventions | | integration/api/odata/Servers/GetConventions(ConventionSetID={conventionsetid}) | |
GenerateConventionName | | integration/api/odata/Servers/GenerateConventionName(ConventionID={conventionid}) | |
DownloadFile | WS-ReadFile | integration/api/odata/Servers({key})/DownloadFile(FileName={filename}) | |
GetConventionSets | | integration/api/odata/Servers/GetConventionSets(EntityTypeID={entitytypeid}) | |
GetConventions | | integration/api/odata/Servers/GetConventions(ConventionSetID={conventionsetid}) | |
GenerateConventionName | | integration/api/odata/Servers/GenerateConventionName(ConventionID={conventionid}) | |
GetAuditLogData | WS-ReadAuditLog | integration/api/odata/Servers({key})/GetAuditLogData | Function used to export all audit information for a specific entity. Please use the following Content-Type:application/vnd.openxmlformats-officedocument.spreadsheetml.sheet for file download |
Servers Custom Routes
|
CustomRoute | Required Permission(s) | Supported Method(s) | Description |
---|
integration/api/odata/Servers/In(Ids={ids}) | |
GET
| |
integration/api/odata/Servers/NotIn(Ids={ids}) | |
GET
| |
integration/api/odata/Servers({key})/InternalEquipmentItems | |
POST
| |
integration/api/odata/Servers({key})/InternalEquipmentItems({relatedKey}) | |
PATCH
| |
integration/api/odata/Servers({key})/InternalEquipmentItems({relatedKey}) | |
DELETE
| |
integration/api/odata/Servers({key})/Notes({relatedKey}) | |
GET
| |
integration/api/odata/Servers({key})/Notes | |
GET
| |
integration/api/odata/Servers({key})/Notes | |
POST
| |
integration/api/odata/Servers({key})/Notes | |
DELETE
| |
integration/api/odata/Servers({key})/Notes({relatedKey}) | |
DELETE
| |
integration/api/odata/Servers({key})/Notes({relatedKey}) | |
PATCH
| |
integration/api/odata/Servers({key})/Peripherals({relatedKey})/Notes({nestedRelatedKey}) | |
GET
| |
integration/api/odata/Servers({key})/Peripherals({relatedKey})/Notes | |
GET
| |
integration/api/odata/Servers({key})/Peripherals({relatedKey})/Notes({nestedRelatedKey}) | |
PATCH
| |
integration/api/odata/Servers({key})/Peripherals({relatedKey})/Notes | |
POST
| |
integration/api/odata/Servers({key})/Peripherals({relatedKey})/Notes | |
DELETE
| |
integration/api/odata/Servers({key})/Peripherals({relatedKey})/Notes({nestedRelatedKey}) | |
DELETE
| |
integration/api/odata/Servers({key})/AssociatedAssets({relatedKey}) | |
DELETE
| |
integration/api/odata/Servers({key})/AssociatedAssets({relatedKey})/Notes({nestedRelatedKey}) | |
GET
| |
integration/api/odata/Servers({key})/AssociatedAssets({relatedKey})/Notes | |
GET
| |
integration/api/odata/Servers({key})/AssociatedAssets({relatedKey})/Notes({nestedRelatedKey}) | |
PATCH
| |
integration/api/odata/Servers({key})/AssociatedAssets({relatedKey})/Notes | |
POST
| |
integration/api/odata/Servers({key})/AssociatedAssets({relatedKey})/Notes | |
DELETE
| |
integration/api/odata/Servers({key})/AssociatedAssets({relatedKey})/Notes({nestedRelatedKey}) | |
DELETE
| |
integration/api/odata/Servers({key})/Graphs | |
GET
| |
integration/api/odata/Servers({key})/Graphs({relatedKey}) | |
GET
| |
integration/api/odata/Servers({key})/Graphs({relatedKey}) | |
PATCH
| |
integration/api/odata/Servers({key})/Graphs | |
POST
| |
integration/api/odata/Servers({key})/Graphs({relatedKey}) | |
DELETE
| |
integration/api/odata/Servers({key})/GetAvailableCabinetUs(CabinetID={cabinetId}) | WS-ReadCabinet |
GET
| |
integration/api/odata/Servers({key})/PhysicalPartitions | |
POST
| |
integration/api/odata/Servers({key})/PhysicalPartitions | |
PATCH
| |
integration/api/odata/Servers({key})/PhysicalPartitions({relatedKey}) | |
DELETE
| |
integration/api/odata/Servers({key})/Peripherals | |
POST
| |
integration/api/odata/Servers({key})/Peripherals({relatedKey}) | |
DELETE
| |
integration/api/odata/Servers({key})/GetServiceRequests | |
GET
| |
integration/api/odata/Servers({key})/CustomFields | WS-ReadCustomFieldServer |
GET
| |
integration/api/odata/Servers({key})/CustomFields | WS-ModifyCustomFieldServer |
POST
| |
integration/api/odata/Servers({key})/CustomFields({relatedKey}) | WS-ModifyCustomFieldServer |
PATCH
| |
integration/api/odata/Servers({key})/CustomFields({relatedKey}) | WS-ModifyCustomFieldServer |
DELETE
| |
integration/api/odata/Servers({key})/Warranty | WS-ReadServer |
GET
| |
integration/api/odata/Servers({key})/Warranty | WS-ModifyServer |
POST
| |
integration/api/odata/Servers({key})/Warranty | WS-ModifyServer |
PATCH
| |
integration/api/odata/Servers({key})/Warranty | WS-ModifyServer |
DELETE
| |
integration/api/odata/Servers({key})/Maintenance | WS-ReadServer |
GET
| |
integration/api/odata/Servers({key})/Maintenance | WS-ModifyServer |
POST
| |
integration/api/odata/Servers({key})/Maintenance | WS-ModifyServer |
PATCH
| |
integration/api/odata/Servers({key})/Maintenance | WS-ModifyServer |
DELETE
| |
integration/api/odata/Servers({key})/AssetMounting | |
GET
| |
integration/api/odata/Servers({key})/KvmSwitchPortConsumerLinks({relatedKey}) | WS-ModifyKVMSwitchPortConsumerLink |
DELETE
| |
integration/api/odata/Servers({key})/Ownership | WS-ReadBusinessGroupAssetMap |
GET
| |
integration/api/odata/Servers({key})/Ownership({relatedKey}) | WS-ReadBusinessGroupAssetMap |
GET
| |
integration/api/odata/Servers({key})/Ownership | WS-AddBusinessGroupAssetMap |
POST
| |
integration/api/odata/Servers({key})/Ownership({relatedKey}) | WS-ModifyBusinessGroupAssetMap |
PATCH
| |
integration/api/odata/Servers({key})/Ownership({relatedKey}) | WS-ModifyBusinessGroupAssetMap |
DELETE
| |
integration/api/odata/Servers({key})/Support | WS-ReadSupportGroupAssetMap |
GET
| |
integration/api/odata/Servers({key})/Support({relatedKey}) | WS-ReadSupportGroupAssetMap |
GET
| |
integration/api/odata/Servers({key})/Support | WS-AddSupportGroupAssetMap |
POST
| |
integration/api/odata/Servers({key})/Support({relatedKey}) | WS-ModifySupportGroupAssetMap |
PATCH
| |
integration/api/odata/Servers({key})/Support({relatedKey}) | WS-ModifySupportGroupAssetMap |
DELETE
| |
integration/api/odata/Servers({key})/Files | |
DELETE
| |
Servers Nested Properties
|
NestedProperty | Supported Method(s) |
---|
Ownership |
BIND
POST
PATCH
|
Support |
BIND
POST
PATCH
|
CustomFields |
POST
PATCH
|
Maintenance |
POST
PATCH
|
Warranty |
POST
PATCH
|
AssetIPAddressMap |
POST
PATCH
|
LocationGroup | |
AssociatedAssets |
BIND
|
ServerHosts |
POST
PATCH
|
PhysicalPartitions |
POST
PATCH
|
InternalEquipmentItems |
POST
PATCH
|
Peripherals |
BIND
POST
PATCH
|
InputConnectors |
PATCH
|
Graphs |
POST
PATCH
|
UMounting |
POST
PATCH
|
ChassisMountedAssetMap |
POST
PATCH
|
Verb(s) | Required Permission(s) | Link | Description |
---|
PUT | WS-ModifyServiceRequest | integration/api/odata/ServiceRequests({key}) | |
POST | WS-AddServiceRequest | integration/api/odata/ServiceRequests | |
POST | | integration/api/odata/ServiceRequests({key}) | |
PATCH | WS-ModifyServiceRequest | integration/api/odata/ServiceRequests({key}) | |
GET | WS-ReadServiceRequest | integration/api/odata/ServiceRequests | |
GET | WS-ReadServiceRequest | integration/api/odata/ServiceRequests({key}) | |
ServiceRequests Actions
|
Action | Required Permission(s) | Link | Description |
---|
Copy | WS-AddServiceRequest | integration/api/odata/ServiceRequests({key})/Copy | |
Start | WS-AddServiceRequest, WS-ModifyServiceRequest | integration/api/odata/ServiceRequests({key})/Start(ServiceRequest={servicerequest}) | |
SetStatus | WS-ModifyServiceRequest | integration/api/odata/ServiceRequests({key})/SetStatus(Status={status}) | |
CreateAsset | | integration/api/odata/ServiceRequests({key})/CreateAsset(Asset={asset}) | |
UploadFile | WS-AddFile | integration/api/odata/ServiceRequests({key})/UploadFile(File={file}) | |
DeleteFile | WS-ModifyFile | integration/api/odata/ServiceRequests({key})/DeleteFile(FileName={filename}) | |
ServiceRequests Functions
|
Function | Required Permission(s) | Link | Description |
---|
GetMyGroupsRequests | WS-ReadServiceRequest | integration/api/odata/ServiceRequests/GetMyGroupsRequests | |
InstantiateFromDefinition | WS-ReadProcess | integration/api/odata/ServiceRequests/InstantiateFromDefinition(ProcessID={processid}, RequestedByAssigneeID={requestedbyassigneeid}) | |
GetAssetServiceRequests | WS-ReadServiceRequest | integration/api/odata/ServiceRequests({key})/GetAssetServiceRequests(assetIds={assetids}) | |
DownloadFile | WS-ReadFile | integration/api/odata/ServiceRequests({key})/DownloadFile(FileName={filename}) | |
GetControlAssets | WS-ReadGetControlAssets | integration/api/odata/ServiceRequests({key})/GetControlAssets(formControlId={formcontrolid}) | |
ServiceRequests Custom Routes
|
CustomRoute | Required Permission(s) | Supported Method(s) | Description |
---|
integration/api/odata/ServiceRequests({key})/Assignees({relatedKey}) | WS-ModifyAssignee |
POST
| |
integration/api/odata/ServiceRequests({key})/Assignees({relatedKey}) | WS-ModifyAssignee |
DELETE
| |
integration/api/odata/ServiceRequests({key})/Notes({relatedKey}) | |
GET
| |
integration/api/odata/ServiceRequests({key})/Notes | |
GET
| |
integration/api/odata/ServiceRequests({key})/Notes | |
POST
| |
integration/api/odata/ServiceRequests({key})/Notes | |
DELETE
| |
integration/api/odata/ServiceRequests({key})/Notes({relatedKey}) | |
DELETE
| |
integration/api/odata/ServiceRequests({key})/Notes({relatedKey}) | |
PATCH
| |
integration/api/odata/ServiceRequests | |
GET
| |
integration/api/odata/ServiceRequests({key})/Files | |
DELETE
| |
integration/api/odata/ServiceRequests/In(Ids={ids}) | |
GET
| |
integration/api/odata/ServiceRequests/NotIn(Ids={ids}) | |
GET
| |
ServiceRequests Nested Properties
No nested properties
Verb(s) | Required Permission(s) | Link | Description |
---|
POST | WS-AddShelf | integration/api/odata/Shelfs | |
DELETE | | integration/api/odata/Shelfs({key}) | |
PATCH | WS-ModifyShelf | integration/api/odata/Shelfs({key}) | |
GET | WS-ReadShelf | integration/api/odata/Shelfs | |
GET | WS-ReadShelf | integration/api/odata/Shelfs({key}) | |
Shelfs Actions
No actions
Shelfs Functions
No functions
Shelfs Custom Routes
|
CustomRoute | Required Permission(s) | Supported Method(s) | Description |
---|
integration/api/odata/Shelfs/In(Ids={ids}) | |
GET
| |
integration/api/odata/Shelfs/NotIn(Ids={ids}) | |
GET
| |
Shelfs Nested Properties
No nested properties
Verb(s) | Required Permission(s) | Link | Description |
---|
GET | | integration/api/odata/SoftwareManufacturers | |
GET | | integration/api/odata/SoftwareManufacturers({key}) | |
SoftwareManufacturers Actions
No actions
SoftwareManufacturers Functions
No functions
SoftwareManufacturers Custom Routes
|
CustomRoute | Required Permission(s) | Supported Method(s) | Description |
---|
integration/api/odata/SoftwareManufacturers/In(Ids={ids}) | |
GET
| |
integration/api/odata/SoftwareManufacturers/NotIn(Ids={ids}) | |
GET
| |
SoftwareManufacturers Nested Properties
No nested properties
Verb(s) | Required Permission(s) | Link | Description |
---|
POST | WS-AddSoftware | integration/api/odata/Softwares | |
DELETE | WS-ModifySoftware | integration/api/odata/Softwares({key}) | |
PATCH | WS-ModifySoftware | integration/api/odata/Softwares({key}) | |
GET | WS-ReadSoftware | integration/api/odata/Softwares | |
GET | WS-ReadSoftware | integration/api/odata/Softwares({key}) | |
Softwares Actions
|
Action | Required Permission(s) | Link | Description |
---|
Cancel | | integration/api/odata/Softwares({key})/Cancel | Function that will cancel/delete a software in Planned status. |
Activate | | integration/api/odata/Softwares({key})/Activate | Function that will move a software in Active status. |
Deactivate | | integration/api/odata/Softwares({key})/Deactivate | |
UploadFile | WS-AddFile | integration/api/odata/Softwares({key})/UploadFile(File={file}) | |
DeleteFile | WS-ModifyFile | integration/api/odata/Softwares({key})/DeleteFile(FileName={filename}) | |
Softwares Functions
|
Function | Required Permission(s) | Link | Description |
---|
DownloadFile | WS-ReadFile | integration/api/odata/Softwares({key})/DownloadFile(FileName={filename}) | |
Softwares Custom Routes
|
CustomRoute | Required Permission(s) | Supported Method(s) | Description |
---|
integration/api/odata/Softwares | |
GET
| |
integration/api/odata/Softwares({key})/Files | |
DELETE
| |
integration/api/odata/Softwares/In(Ids={ids}) | |
GET
| |
integration/api/odata/Softwares/NotIn(Ids={ids}) | |
GET
| |
Softwares Nested Properties
No nested properties
Verb(s) | Required Permission(s) | Link | Description |
---|
GET | | integration/api/odata/SoftwareTypes | |
GET | | integration/api/odata/SoftwareTypes({key}) | |
SoftwareTypes Actions
No actions
SoftwareTypes Functions
No functions
SoftwareTypes Custom Routes
|
CustomRoute | Required Permission(s) | Supported Method(s) | Description |
---|
integration/api/odata/SoftwareTypes/In(Ids={ids}) | |
GET
| |
integration/api/odata/SoftwareTypes/NotIn(Ids={ids}) | |
GET
| |
SoftwareTypes Nested Properties
No nested properties
Verb(s) | Required Permission(s) | Link | Description |
---|
POST | WS-AddAuxiliaryMaterial | integration/api/odata/StandardGeneratorAuxiliaryMaterials | |
PATCH | WS-ModifyAuxiliaryMaterial | integration/api/odata/StandardGeneratorAuxiliaryMaterials({key}) | |
DELETE | WS-ModifyAuxiliaryMaterial | integration/api/odata/StandardGeneratorAuxiliaryMaterials({key}) | |
GET | WS-ReadAuxiliaryMaterial | integration/api/odata/StandardGeneratorAuxiliaryMaterials | |
GET | WS-ReadAuxiliaryMaterial | integration/api/odata/StandardGeneratorAuxiliaryMaterials({key}) | |
StandardGeneratorAuxiliaryMaterials Actions
|
Action | Required Permission(s) | Link | Description |
---|
Cancel | WS-ModifyAuxiliaryMaterial | integration/api/odata/StandardGeneratorAuxiliaryMaterials({key})/Cancel | |
Activate | WS-ModifyAuxiliaryMaterial | integration/api/odata/StandardGeneratorAuxiliaryMaterials({key})/Activate | Function that will move a material in Active status. |
Deactivate | WS-ModifyAuxiliaryMaterial | integration/api/odata/StandardGeneratorAuxiliaryMaterials({key})/Deactivate | Function that will move a material in Inactive status. |
UploadFile | WS-AddFile | integration/api/odata/StandardGeneratorAuxiliaryMaterials({key})/UploadFile(File={file}) | |
DeleteFile | WS-ModifyFile | integration/api/odata/StandardGeneratorAuxiliaryMaterials({key})/DeleteFile(FileName={filename}) | |
StandardGeneratorAuxiliaryMaterials Functions
|
Function | Required Permission(s) | Link | Description |
---|
DownloadFile | WS-ReadFile | integration/api/odata/StandardGeneratorAuxiliaryMaterials({key})/DownloadFile(FileName={filename}) | |
GetAuditLogData | WS-ReadAuditLog | integration/api/odata/StandardGeneratorAuxiliaryMaterials({key})/GetAuditLogData | Function used to export all audit information for a specific entity. Please use the following Content-Type:application/vnd.openxmlformats-officedocument.spreadsheetml.sheet for file download |
StandardGeneratorAuxiliaryMaterials Custom Routes
|
CustomRoute | Required Permission(s) | Supported Method(s) | Description |
---|
integration/api/odata/StandardGeneratorAuxiliaryMaterials/In(Ids={ids}) | |
GET
| |
integration/api/odata/StandardGeneratorAuxiliaryMaterials/NotIn(Ids={ids}) | |
GET
| |
integration/api/odata/StandardGeneratorAuxiliaryMaterials({key})/Files | |
DELETE
| |
StandardGeneratorAuxiliaryMaterials Nested Properties
No nested properties
Verb(s) | Required Permission(s) | Link | Description |
---|
POST | WS-ModifyNetworkMaterial | integration/api/odata/StandardNetworkMaterials({key}) | |
POST | WS-AddNetworkMaterial | integration/api/odata/StandardNetworkMaterials | |
PATCH | WS-ModifyNetworkMaterial | integration/api/odata/StandardNetworkMaterials({key}) | |
DELETE | WS-ModifyNetworkMaterial | integration/api/odata/StandardNetworkMaterials({key}) | |
GET | WS-ReadNetworkMaterial | integration/api/odata/StandardNetworkMaterials | |
GET | WS-ReadNetworkMaterial | integration/api/odata/StandardNetworkMaterials({key}) | |
StandardNetworkMaterials Actions
|
Action | Required Permission(s) | Link | Description |
---|
Cancel | WS-ModifyNetworkMaterial | integration/api/odata/StandardNetworkMaterials({key})/Cancel | |
Activate | WS-ModifyNetworkMaterial | integration/api/odata/StandardNetworkMaterials({key})/Activate | Function that will move a material in Active status. |
Deactivate | WS-ModifyNetworkMaterial | integration/api/odata/StandardNetworkMaterials({key})/Deactivate | Function that will move a material in Inactive status. |
UploadFile | WS-AddFile | integration/api/odata/StandardNetworkMaterials({key})/UploadFile(File={file}) | |
DeleteFile | WS-ModifyFile | integration/api/odata/StandardNetworkMaterials({key})/DeleteFile(FileName={filename}) | |
StandardNetworkMaterials Functions
|
Function | Required Permission(s) | Link | Description |
---|
DownloadFile | WS-ReadFile | integration/api/odata/StandardNetworkMaterials({key})/DownloadFile(FileName={filename}) | |
GetAuditLogData | WS-ReadAuditLog | integration/api/odata/StandardNetworkMaterials({key})/GetAuditLogData | Function used to export all audit information for a specific entity. Please use the following Content-Type:application/vnd.openxmlformats-officedocument.spreadsheetml.sheet for file download |
StandardNetworkMaterials Custom Routes
|
CustomRoute | Required Permission(s) | Supported Method(s) | Description |
---|
integration/api/odata/StandardNetworkMaterials/In(Ids={ids}) | |
GET
| |
integration/api/odata/StandardNetworkMaterials/NotIn(Ids={ids}) | |
GET
| |
integration/api/odata/StandardNetworkMaterials({key})/Files | |
DELETE
| |
StandardNetworkMaterials Nested Properties
No nested properties
Verb(s) | Required Permission(s) | Link | Description |
---|
POST | WS-AddPDUMaterial | integration/api/odata/StandardPDUMaterials | |
PATCH | WS-ModifyPDUMaterial | integration/api/odata/StandardPDUMaterials({key}) | |
DELETE | WS-ModifyPDUMaterial | integration/api/odata/StandardPDUMaterials({key}) | |
GET | WS-ReadPDUMaterial | integration/api/odata/StandardPDUMaterials | |
GET | WS-ReadPDUMaterial | integration/api/odata/StandardPDUMaterials({key}) | |
StandardPDUMaterials Actions
|
Action | Required Permission(s) | Link | Description |
---|
Cancel | WS-ModifyPDUMaterial | integration/api/odata/StandardPDUMaterials({key})/Cancel | |
Activate | WS-ModifyPDUMaterial | integration/api/odata/StandardPDUMaterials({key})/Activate | Function that will move a material in Active status. |
Deactivate | WS-ModifyPDUMaterial | integration/api/odata/StandardPDUMaterials({key})/Deactivate | Function that will move a material in Inactive status. |
UploadFile | WS-AddFile | integration/api/odata/StandardPDUMaterials({key})/UploadFile(File={file}) | |
DeleteFile | WS-ModifyFile | integration/api/odata/StandardPDUMaterials({key})/DeleteFile(FileName={filename}) | |
StandardPDUMaterials Functions
|
Function | Required Permission(s) | Link | Description |
---|
DownloadFile | WS-ReadFile | integration/api/odata/StandardPDUMaterials({key})/DownloadFile(FileName={filename}) | |
GetAuditLogData | WS-ReadAuditLog | integration/api/odata/StandardPDUMaterials({key})/GetAuditLogData | Function used to export all audit information for a specific entity. Please use the following Content-Type:application/vnd.openxmlformats-officedocument.spreadsheetml.sheet for file download |
StandardPDUMaterials Custom Routes
|
CustomRoute | Required Permission(s) | Supported Method(s) | Description |
---|
integration/api/odata/StandardPDUMaterials/In(Ids={ids}) | |
GET
| |
integration/api/odata/StandardPDUMaterials/NotIn(Ids={ids}) | |
GET
| |
integration/api/odata/StandardPDUMaterials({key})/Files | |
DELETE
| |
StandardPDUMaterials Nested Properties
No nested properties
Verb(s) | Required Permission(s) | Link | Description |
---|
POST | WS-ModifyServerMaterial | integration/api/odata/StandardServerMaterials({key}) | |
POST | WS-AddServerMaterial | integration/api/odata/StandardServerMaterials | |
PATCH | WS-ModifyServerMaterial | integration/api/odata/StandardServerMaterials({key}) | |
DELETE | WS-ModifyServerMaterial | integration/api/odata/StandardServerMaterials({key}) | |
GET | WS-ReadServerMaterial | integration/api/odata/StandardServerMaterials | |
GET | WS-ReadServerMaterial | integration/api/odata/StandardServerMaterials({key}) | |
StandardServerMaterials Actions
|
Action | Required Permission(s) | Link | Description |
---|
Cancel | WS-ModifyServerMaterial | integration/api/odata/StandardServerMaterials({key})/Cancel | |
Activate | WS-ModifyServerMaterial | integration/api/odata/StandardServerMaterials({key})/Activate | Function that will move a material in Active status. |
Deactivate | WS-ModifyServerMaterial | integration/api/odata/StandardServerMaterials({key})/Deactivate | Function that will move a material in Inactive status. |
UploadFile | WS-AddFile | integration/api/odata/StandardServerMaterials({key})/UploadFile(File={file}) | |
DeleteFile | WS-ModifyFile | integration/api/odata/StandardServerMaterials({key})/DeleteFile(FileName={filename}) | |
StandardServerMaterials Functions
|
Function | Required Permission(s) | Link | Description |
---|
DownloadFile | WS-ReadFile | integration/api/odata/StandardServerMaterials({key})/DownloadFile(FileName={filename}) | |
GetAuditLogData | WS-ReadAuditLog | integration/api/odata/StandardServerMaterials({key})/GetAuditLogData | Function used to export all audit information for a specific entity. Please use the following Content-Type:application/vnd.openxmlformats-officedocument.spreadsheetml.sheet for file download |
StandardServerMaterials Custom Routes
|
CustomRoute | Required Permission(s) | Supported Method(s) | Description |
---|
integration/api/odata/StandardServerMaterials/In(Ids={ids}) | |
GET
| |
integration/api/odata/StandardServerMaterials/NotIn(Ids={ids}) | |
GET
| |
integration/api/odata/StandardServerMaterials({key})/Files | |
DELETE
| |
StandardServerMaterials Nested Properties
No nested properties
Verb(s) | Required Permission(s) | Link | Description |
---|
PATCH | WS-ModifyStaticSwitch | integration/api/odata/StaticSwitches({key}) | |
POST | WS-AddStaticSwitch | integration/api/odata/StaticSwitches | |
DELETE | WS-ModifyStaticSwitch | integration/api/odata/StaticSwitches({key}) | |
POST | WS-ModifyStaticSwitch | integration/api/odata/StaticSwitches({key}) | |
GET | WS-ReadStaticSwitch | integration/api/odata/StaticSwitches | |
GET | WS-ReadStaticSwitch | integration/api/odata/StaticSwitches({key}) | |
StaticSwitches Actions
|
Action | Required Permission(s) | Link | Description |
---|
BeginMove | WS-PlanRecycleStaticSwitch, WS-PlanDecommissionStaticSwitch | integration/api/odata/StaticSwitches({key})/BeginMove(RelocateType={relocatetype}) | Function that is used to move the selected asset in a planned state, Moving, Recycling or Decommissioning, depending on the RelocateType provided as parameter. The response contains the Planned AssetId. |
CancelMove | WS-CancelRecycleStaticSwitch, WS-CancelDecommissionStaticSwitch | integration/api/odata/StaticSwitches({key})/CancelMove | Function that is used to cancel planned action. The selected asset will become Active/Operational. |
CompleteMove | WS-CompleteRecycleStaticSwitch, WS-CompleteDecommissionStaticSwitch | integration/api/odata/StaticSwitches({key})/CompleteMove | Function that is used to finish planned action. The selected asset will become Active/Operational, Recycled/Available or Decommissioned/Decommissioned, depending on the Planned entity type (Move, Recycle or Deccommission). |
DirectMove | WS-SetLocationStaticSwitch | integration/api/odata/StaticSwitches({key})/DirectMove(RelocateType={relocatetype}, LocationGroupID={locationgroupid}) | Function that is used to directly move an asset to a new location in a final state. |
CompleteCreation | WS-ModifyStaticSwitch | integration/api/odata/StaticSwitches({key})/CompleteCreation | Function that moves an asset from Planned/(Pre)Procurement to Active/Operational. |
SetMaterial | | integration/api/odata/StaticSwitches({key})/SetMaterial(NewMaterialID={newmaterialid}) | Function that is used to change the material on an existing asset. This action is only supported for Receptacles and Power Strips. |
AddRealTimeValues | WS-AddAssetRealtimeData | integration/api/odata/StaticSwitches({key})/AddRealTimeValues(RealTimeInfo={realtimeinfo}, RealTimeValue={realtimevalue}) | Adds a provider specfic recorded real-time value against an asset or its associated outlet. Custom metrics are only allowed on assets whereas load, power and voltage metrics are allowed against assets, outlets or their relevant phases. |
AddNetworkAsset | WS-ReadNetworkConnection,WS-AddNetworkConnection | integration/api/odata/StaticSwitches({key})/AddNetworkAsset(NetworkAssetId={networkassetid}) | Function that is adding the selected asset in the list of available asset to be used in network connections. The mapping between the two assets is created by providing the NetworkAssetId parameter in the BODY, NetworkAssetId representing the AssetID of the asset to be added in the list of available assets. |
RemoveNetworkAsset | WS-ModifyNetworkConnection | integration/api/odata/StaticSwitches({key})/RemoveNetworkAsset(NetworkAssetId={networkassetid}, NetworkLinkerType={networklinkertype}) | Function that removes an asset from the association list of available asset to be used in network connections. |
UploadFile | WS-AddFile | integration/api/odata/StaticSwitches({key})/UploadFile(File={file}) | |
DeleteFile | WS-ModifyFile | integration/api/odata/StaticSwitches({key})/DeleteFile(FileName={filename}) | |
StaticSwitches Functions
|
Function | Required Permission(s) | Link | Description |
---|
GetTotalSystemPowerConsumption | WS-ReadStaticSwitch | integration/api/odata/StaticSwitches({key})/GetTotalSystemPowerConsumption | Function that returns the TotalSystemPowerConsumption for the selected asset. |
GetRealTimePowerInfo | WS-ReadStaticSwitch | integration/api/odata/StaticSwitches({key})/GetRealTimePowerInfo | |
GetDiscoveryAssetPage | WS-ReadStaticSwitch | integration/api/odata/StaticSwitches({key})/GetDiscoveryAssetPage | Function that returns a collection of entities of type Nlyte.Model.AssetMapping. Used to determine external providers. |
RecordModifiedInfo | WS-ReadStaticSwitch | integration/api/odata/StaticSwitches({key})/RecordModifiedInfo | Function that returns an entity of type Nlyte.Model.AuditLogInfo and provides information regarding last modifications against the current asset |
GetMountedChildAssets | | integration/api/odata/StaticSwitches({key})/GetMountedChildAssets(IncludeHosts={includehosts}, IncludeCards={includecards}) | Function that returns a collection of entities of type Nlyte.Model.MountedAssetSummary representing the list of mounted assets in the provided asset. The function is called as follows: Assets(AssetID)/GetMountedChildAssets(IncludeHosts=true,IncludeCards=true) where AssetID is the parent for which the children are retrieved. |
GetDistributorsWithFreeOutlets | WS-ReadAssetToAssetMapping | integration/api/odata/StaticSwitches({key})/GetDistributorsWithFreeOutlets(SearchTerm={searchterm}, SearchTermOption={searchtermoption}, LocationDepth={locationdepth}, MaterialTypeID={materialtypeid}, MaterialSubtypeID={materialsubtypeid}) | Function that returns a collection of entities of type Nlyte.Model.Distributor representing available power suppliers. |
SearchAssetNetworkPortLinkage | WS-ReadNetworkConnection | integration/api/odata/StaticSwitches({key})/SearchAssetNetworkPortLinkage(SearchTerm={searchterm}, SearchTermOption={searchtermoption}, CabinetMountingStatus={cabinetmountingstatus}, LocationTarget={locationtarget}, NetworkTypes={networktypes}, PortLocation={portlocation}) | Function that returns a collection of entities of type Nlyte.Model.AssetNetworkPortLinkage representing available assets to be used in network connections. |
GetRealTimeValues | WS-ReadAssetRealtimeData | integration/api/odata/StaticSwitches({key})/GetRealTimeValues | Function that returns a collection of entities of type Nlyte.Model.RealTimeValue. |
GetAssetSummaries | | integration/api/odata/StaticSwitches({key})/GetAssetSummaries(OwnedPeripherals={ownedperipherals}, IncludeHosts={includehosts}) | |
GetNetworkCardPortsInfo | WS-ReadNetworkConnection | integration/api/odata/StaticSwitches({key})/GetNetworkCardPortsInfo | Returns an object of type Nlyte.Model.NetworkResults having information about Copper and Fiber Ports |
GetNetworkCardPortConnections | WS-ReadNetworkConnection | integration/api/odata/StaticSwitches({key})/GetNetworkCardPortConnections | Returns an object of type Nlyte.Model.NetworkResults having information about Copper and Fiber Port connections |
GetNetworkAssetSummary | WS-ReadNetworkConnection | integration/api/odata/StaticSwitches({key})/GetNetworkAssetSummary | Returns an object of type Nlyte.Model.NetworkResults having information about the networkable assets. |
ListPowerConsumers | | integration/api/odata/StaticSwitches({key})/ListPowerConsumers | Function that returns a collection of Nlyte.Model.Graph entities. Used to identify available Output Connector used in power connections. |
SupportsPlannedMove | | integration/api/odata/StaticSwitches({key})/SupportsPlannedMove | |
GetTotalSystemWeight | | integration/api/odata/StaticSwitches({key})/GetTotalSystemWeight | Function that returns the TotalSystemWeight for the selected asset. |
GetMountedOnAssetID | | integration/api/odata/StaticSwitches({key})/GetMountedOnAssetID | |
GetAssetsReportData | WS-ReadNetwork,WS-ReadCabinet,WS-ReadPeripheral,WS-ReadKVMSwitch,WS-ReadServer,WS-ReadPDU,WS-ReadPowerStrip,WS-ReadAirConditioning,WS-ReadReceptacle,WS-ReadChassis,WS-ReadUPS,WS-ReadAuxiliary,WS-ReadStaticSwitch,WS-ReadServerHost | integration/api/odata/StaticSwitches/GetAssetsReportData(assetIds={assetids}) | |
DownloadFile | WS-ReadFile | integration/api/odata/StaticSwitches({key})/DownloadFile(FileName={filename}) | |
GetAuditLogData | WS-ReadAuditLog | integration/api/odata/StaticSwitches({key})/GetAuditLogData | Function used to export all audit information for a specific entity. Please use the following Content-Type:application/vnd.openxmlformats-officedocument.spreadsheetml.sheet for file download |
StaticSwitches Custom Routes
|
CustomRoute | Required Permission(s) | Supported Method(s) | Description |
---|
integration/api/odata/StaticSwitches({key})/Wires | |
GET
| |
integration/api/odata/StaticSwitches({key})/Notes({relatedKey}) | |
GET
| |
integration/api/odata/StaticSwitches({key})/Notes | |
GET
| |
integration/api/odata/StaticSwitches({key})/Notes | |
POST
| |
integration/api/odata/StaticSwitches({key})/Notes | |
DELETE
| |
integration/api/odata/StaticSwitches({key})/Notes({relatedKey}) | |
DELETE
| |
integration/api/odata/StaticSwitches({key})/Notes({relatedKey}) | |
PATCH
| |
integration/api/odata/StaticSwitches({key})/Utilities | |
GET
| |
integration/api/odata/StaticSwitches({key})/Utilities({relatedKey}) | |
GET
| |
integration/api/odata/StaticSwitches({key})/Utilities({relatedKey}) | |
DELETE
| |
integration/api/odata/StaticSwitches({key})/Graphs | |
GET
| |
integration/api/odata/StaticSwitches({key})/Graphs({relatedKey}) | |
GET
| |
integration/api/odata/StaticSwitches({key})/Graphs({relatedKey}) | |
PATCH
| |
integration/api/odata/StaticSwitches({key})/Graphs | |
POST
| |
integration/api/odata/StaticSwitches({key})/Graphs({relatedKey}) | |
DELETE
| |
integration/api/odata/StaticSwitches({key})/GetAvailableCabinetUs(CabinetID={cabinetId}) | WS-ReadCabinet |
GET
| |
integration/api/odata/StaticSwitches({key})/GetServiceRequests | |
GET
| |
integration/api/odata/StaticSwitches({key})/CustomFields | WS-ReadCustomFieldStaticSwitch |
GET
| |
integration/api/odata/StaticSwitches({key})/CustomFields | WS-ModifyCustomFieldStaticSwitch |
POST
| |
integration/api/odata/StaticSwitches({key})/CustomFields({relatedKey}) | WS-ModifyCustomFieldStaticSwitch |
PATCH
| |
integration/api/odata/StaticSwitches({key})/CustomFields({relatedKey}) | WS-ModifyCustomFieldStaticSwitch |
DELETE
| |
integration/api/odata/StaticSwitches({key})/Warranty | WS-ReadStaticSwitch |
GET
| |
integration/api/odata/StaticSwitches({key})/Warranty | WS-ModifyStaticSwitch |
POST
| |
integration/api/odata/StaticSwitches({key})/Warranty | WS-ModifyStaticSwitch |
PATCH
| |
integration/api/odata/StaticSwitches({key})/Warranty | WS-ModifyStaticSwitch |
DELETE
| |
integration/api/odata/StaticSwitches({key})/Maintenance | WS-ReadStaticSwitch |
GET
| |
integration/api/odata/StaticSwitches({key})/Maintenance | WS-ModifyStaticSwitch |
POST
| |
integration/api/odata/StaticSwitches({key})/Maintenance | WS-ModifyStaticSwitch |
PATCH
| |
integration/api/odata/StaticSwitches({key})/Maintenance | WS-ModifyStaticSwitch |
DELETE
| |
integration/api/odata/StaticSwitches({key})/AssetMounting | |
GET
| |
integration/api/odata/StaticSwitches({key})/Ownership | WS-ReadBusinessGroupAssetMap |
GET
| |
integration/api/odata/StaticSwitches({key})/Ownership({relatedKey}) | WS-ReadBusinessGroupAssetMap |
GET
| |
integration/api/odata/StaticSwitches({key})/Ownership | WS-AddBusinessGroupAssetMap |
POST
| |
integration/api/odata/StaticSwitches({key})/Ownership({relatedKey}) | WS-ModifyBusinessGroupAssetMap |
PATCH
| |
integration/api/odata/StaticSwitches({key})/Ownership({relatedKey}) | WS-ModifyBusinessGroupAssetMap |
DELETE
| |
integration/api/odata/StaticSwitches({key})/Support | WS-ReadSupportGroupAssetMap |
GET
| |
integration/api/odata/StaticSwitches({key})/Support({relatedKey}) | WS-ReadSupportGroupAssetMap |
GET
| |
integration/api/odata/StaticSwitches({key})/Support | WS-AddSupportGroupAssetMap |
POST
| |
integration/api/odata/StaticSwitches({key})/Support({relatedKey}) | WS-ModifySupportGroupAssetMap |
PATCH
| |
integration/api/odata/StaticSwitches({key})/Support({relatedKey}) | WS-ModifySupportGroupAssetMap |
DELETE
| |
integration/api/odata/StaticSwitches({key})/AssociatedAssets({relatedKey}) | |
DELETE
| |
integration/api/odata/StaticSwitches({key})/AssociatedAssets({relatedKey})/Notes({nestedRelatedKey}) | |
GET
| |
integration/api/odata/StaticSwitches({key})/AssociatedAssets({relatedKey})/Notes | |
GET
| |
integration/api/odata/StaticSwitches({key})/AssociatedAssets({relatedKey})/Notes({nestedRelatedKey}) | |
PATCH
| |
integration/api/odata/StaticSwitches({key})/AssociatedAssets({relatedKey})/Notes | |
POST
| |
integration/api/odata/StaticSwitches({key})/AssociatedAssets({relatedKey})/Notes | |
DELETE
| |
integration/api/odata/StaticSwitches({key})/AssociatedAssets({relatedKey})/Notes({nestedRelatedKey}) | |
DELETE
| |
integration/api/odata/StaticSwitches/In(Ids={ids}) | |
GET
| |
integration/api/odata/StaticSwitches/NotIn(Ids={ids}) | |
GET
| |
integration/api/odata/StaticSwitches({key})/Files | |
DELETE
| |
StaticSwitches Nested Properties
|
NestedProperty | Supported Method(s) |
---|
Ownership |
BIND
POST
PATCH
|
Support |
BIND
POST
PATCH
|
CustomFields |
POST
PATCH
|
Maintenance |
POST
PATCH
|
Warranty |
POST
PATCH
|
AssetIPAddressMap |
POST
PATCH
|
LocationGroup | |
AssociatedAssets |
BIND
|
Utilities |
POST
PATCH
|
InputConnectors |
PATCH
|
Graphs |
POST
PATCH
|
UMounting |
POST
PATCH
|
OutputConnectors |
PATCH
|
Verb(s) | Required Permission(s) | Link | Description |
---|
POST | WS-ModifyStaticSwitchMaterial | integration/api/odata/StaticSwitchMaterials({key}) | |
POST | WS-AddStaticSwitchMaterial | integration/api/odata/StaticSwitchMaterials | |
PATCH | WS-ModifyStaticSwitchMaterial | integration/api/odata/StaticSwitchMaterials({key}) | |
DELETE | WS-ModifyStaticSwitchMaterial | integration/api/odata/StaticSwitchMaterials({key}) | |
GET | WS-ReadStaticSwitchMaterial | integration/api/odata/StaticSwitchMaterials | |
GET | WS-ReadStaticSwitchMaterial | integration/api/odata/StaticSwitchMaterials({key}) | |
StaticSwitchMaterials Actions
|
Action | Required Permission(s) | Link | Description |
---|
Cancel | WS-ModifyStaticSwitchMaterial | integration/api/odata/StaticSwitchMaterials({key})/Cancel | |
Activate | WS-ModifyStaticSwitchMaterial | integration/api/odata/StaticSwitchMaterials({key})/Activate | Function that will move a material in Active status. |
Deactivate | WS-ModifyStaticSwitchMaterial | integration/api/odata/StaticSwitchMaterials({key})/Deactivate | Function that will move a material in Inactive status. |
UploadFile | WS-AddFile | integration/api/odata/StaticSwitchMaterials({key})/UploadFile(File={file}) | |
DeleteFile | WS-ModifyFile | integration/api/odata/StaticSwitchMaterials({key})/DeleteFile(FileName={filename}) | |
StaticSwitchMaterials Functions
|
Function | Required Permission(s) | Link | Description |
---|
DownloadFile | WS-ReadFile | integration/api/odata/StaticSwitchMaterials({key})/DownloadFile(FileName={filename}) | |
GetAuditLogData | WS-ReadAuditLog | integration/api/odata/StaticSwitchMaterials({key})/GetAuditLogData | Function used to export all audit information for a specific entity. Please use the following Content-Type:application/vnd.openxmlformats-officedocument.spreadsheetml.sheet for file download |
StaticSwitchMaterials Custom Routes
|
CustomRoute | Required Permission(s) | Supported Method(s) | Description |
---|
integration/api/odata/StaticSwitchMaterials/In(Ids={ids}) | |
GET
| |
integration/api/odata/StaticSwitchMaterials/NotIn(Ids={ids}) | |
GET
| |
integration/api/odata/StaticSwitchMaterials({key})/Files | |
DELETE
| |
StaticSwitchMaterials Nested Properties
No nested properties
Verb(s) | Required Permission(s) | Link | Description |
---|
POST | WS-ModifyPeripheralMaterial | integration/api/odata/StoragePeripheralMaterials({key}) | |
POST | WS-AddPeripheralMaterial | integration/api/odata/StoragePeripheralMaterials | |
PATCH | WS-ModifyPeripheralMaterial | integration/api/odata/StoragePeripheralMaterials({key}) | |
DELETE | WS-ModifyPeripheralMaterial | integration/api/odata/StoragePeripheralMaterials({key}) | |
GET | WS-ReadPeripheralMaterial | integration/api/odata/StoragePeripheralMaterials | |
GET | WS-ReadPeripheralMaterial | integration/api/odata/StoragePeripheralMaterials({key}) | |
StoragePeripheralMaterials Actions
|
Action | Required Permission(s) | Link | Description |
---|
Cancel | WS-ModifyPeripheralMaterial | integration/api/odata/StoragePeripheralMaterials({key})/Cancel | |
Activate | WS-ModifyPeripheralMaterial | integration/api/odata/StoragePeripheralMaterials({key})/Activate | Function that will move a material in Active status. |
Deactivate | WS-ModifyPeripheralMaterial | integration/api/odata/StoragePeripheralMaterials({key})/Deactivate | Function that will move a material in Inactive status. |
UploadFile | WS-AddFile | integration/api/odata/StoragePeripheralMaterials({key})/UploadFile(File={file}) | |
DeleteFile | WS-ModifyFile | integration/api/odata/StoragePeripheralMaterials({key})/DeleteFile(FileName={filename}) | |
StoragePeripheralMaterials Functions
|
Function | Required Permission(s) | Link | Description |
---|
DownloadFile | WS-ReadFile | integration/api/odata/StoragePeripheralMaterials({key})/DownloadFile(FileName={filename}) | |
GetAuditLogData | WS-ReadAuditLog | integration/api/odata/StoragePeripheralMaterials({key})/GetAuditLogData | Function used to export all audit information for a specific entity. Please use the following Content-Type:application/vnd.openxmlformats-officedocument.spreadsheetml.sheet for file download |
StoragePeripheralMaterials Custom Routes
|
CustomRoute | Required Permission(s) | Supported Method(s) | Description |
---|
integration/api/odata/StoragePeripheralMaterials/In(Ids={ids}) | |
GET
| |
integration/api/odata/StoragePeripheralMaterials/NotIn(Ids={ids}) | |
GET
| |
integration/api/odata/StoragePeripheralMaterials({key})/Files | |
DELETE
| |
StoragePeripheralMaterials Nested Properties
No nested properties
Verb(s) | Required Permission(s) | Link | Description |
---|
POST | WS-AddSubnetLocationGroupMap | integration/api/odata/SubnetLocationGroupMaps | |
DELETE | WS-ModifySubnetLocationGroupMap | integration/api/odata/SubnetLocationGroupMaps({key}) | |
PATCH | WS-ModifySubnetLocationGroupMap | integration/api/odata/SubnetLocationGroupMaps({key}) | |
GET | WS-ReadSubnetLocationGroupMap | integration/api/odata/SubnetLocationGroupMaps | |
GET | WS-ReadSubnetLocationGroupMap | integration/api/odata/SubnetLocationGroupMaps({key}) | |
SubnetLocationGroupMaps Actions
No actions
SubnetLocationGroupMaps Functions
No functions
SubnetLocationGroupMaps Custom Routes
|
CustomRoute | Required Permission(s) | Supported Method(s) | Description |
---|
integration/api/odata/SubnetLocationGroupMaps/In(Ids={ids}) | |
GET
| |
integration/api/odata/SubnetLocationGroupMaps/NotIn(Ids={ids}) | |
GET
| |
SubnetLocationGroupMaps Nested Properties
No nested properties
Verb(s) | Required Permission(s) | Link | Description |
---|
POST | WS-AddCabinetSubnetMap | integration/api/odata/Subnets | |
DELETE | WS-ModifyCabinetSubnetMap | integration/api/odata/Subnets({key}) | |
PATCH | WS-ModifyCabinetSubnetMap | integration/api/odata/Subnets({key}) | |
GET | WS-ReadCabinetSubnetMap | integration/api/odata/Subnets | |
GET | WS-ReadCabinetSubnetMap | integration/api/odata/Subnets({key}) | |
Subnets Actions
No actions
Subnets Functions
No functions
Subnets Custom Routes
|
CustomRoute | Required Permission(s) | Supported Method(s) | Description |
---|
integration/api/odata/Subnets/In(Ids={ids}) | |
GET
| |
integration/api/odata/Subnets/NotIn(Ids={ids}) | |
GET
| |
Subnets Nested Properties
No nested properties
Verb(s) | Required Permission(s) | Link | Description |
---|
GET | | integration/api/odata/SupplierMaterials | |
GET | | integration/api/odata/SupplierMaterials({key}) | |
SupplierMaterials Actions
No actions
SupplierMaterials Functions
No functions
SupplierMaterials Custom Routes
|
CustomRoute | Required Permission(s) | Supported Method(s) | Description |
---|
integration/api/odata/SupplierMaterials/In(Ids={ids}) | |
GET
| |
integration/api/odata/SupplierMaterials/NotIn(Ids={ids}) | |
GET
| |
SupplierMaterials Nested Properties
No nested properties
Verb(s) | Required Permission(s) | Link | Description |
---|
GET | | integration/api/odata/SupplierMaterialWires | |
GET | | integration/api/odata/SupplierMaterialWires({key}) | |
SupplierMaterialWires Actions
No actions
SupplierMaterialWires Functions
No functions
SupplierMaterialWires Custom Routes
|
CustomRoute | Required Permission(s) | Supported Method(s) | Description |
---|
integration/api/odata/SupplierMaterialWires/In(Ids={ids}) | |
GET
| |
integration/api/odata/SupplierMaterialWires/NotIn(Ids={ids}) | |
GET
| |
SupplierMaterialWires Nested Properties
No nested properties
Verb(s) | Required Permission(s) | Link | Description |
---|
POST | WS-AddSupportGroup | integration/api/odata/SupportGroups | |
DELETE | WS-ModifySupportGroup | integration/api/odata/SupportGroups({key}) | |
PATCH | WS-ModifySupportGroup | integration/api/odata/SupportGroups({key}) | |
POST | WS-ModifySupportGroup | integration/api/odata/SupportGroups({key}) | |
GET | WS-ReadSupportGroup | integration/api/odata/SupportGroups | |
GET | WS-ReadSupportGroup | integration/api/odata/SupportGroups({key}) | |
SupportGroups Actions
No actions
SupportGroups Functions
|
Function | Required Permission(s) | Link | Description |
---|
ListSupportGroupLinkedRecords | WS-ReadSupportGroupAssetMap,WS-ReadServerHostSupportGroupMap,WS-ReadBusinessApplicationSupportGroupMap | integration/api/odata/SupportGroups/ListSupportGroupLinkedRecords(SupportGroupID={supportgroupid}) | |
GetWorkingHours | WS-ReadSupportGroup | integration/api/odata/SupportGroups/GetWorkingHours(AssigneeID={assigneeid}) | |
GetNonWorkingDates | WS-ReadSupportGroup | integration/api/odata/SupportGroups/GetNonWorkingDates(AssigneeID={assigneeid}) | The function will return a collection of Nlyte.Model.ExclusionDate for support groups. |
GetSupportGroupDescendants | WS-ReadSupportGroup | integration/api/odata/SupportGroups({key})/GetSupportGroupDescendants(IncludeSelf={includeself}) | Function returning a collection of Nlyte.Model.SupportGroup representing a tree of children for the selected group. |
GetSupportGroupAscendantsAndSelf | WS-ReadSupportGroup | integration/api/odata/SupportGroups({key})/GetSupportGroupAscendantsAndSelf | Function returning a collection of Nlyte.Model.SupportGroup representing a tree of parents for the selected group. |
SupportGroups Custom Routes
|
CustomRoute | Required Permission(s) | Supported Method(s) | Description |
---|
integration/api/odata/SupportGroups | |
DELETE
| |
integration/api/odata/SupportGroups | |
POST
| |
integration/api/odata/SupportGroups({key})/AssociatedSupportGroups | |
GET
| |
integration/api/odata/SupportGroups({key})/AssociatedSupportGroups({relatedKey}) | |
GET
| |
integration/api/odata/SupportGroups({key})/AssociatedSupportGroups | |
POST
| |
integration/api/odata/SupportGroups({key})/AssociatedSupportGroups({relatedKey}) | |
PATCH
| |
integration/api/odata/SupportGroups({key})/AssociatedSupportGroups({relatedKey}) | |
DELETE
| |
integration/api/odata/SupportGroups({key})/SupportGroupContacts | WS-ReadSupportGroupResourceMap |
GET
| |
integration/api/odata/SupportGroups({key})/SupportGroupContacts({relatedKey}) | WS-ReadSupportGroupResourceMap,WS-ReadResource |
GET
| |
integration/api/odata/SupportGroups({key})/SupportGroupContacts | WS-AddSupportGroupResourceMap |
POST
| |
integration/api/odata/SupportGroups({key})/SupportGroupContacts({relatedKey}) | WS-ModifySupportGroupResourceMap |
PATCH
| |
integration/api/odata/SupportGroups({key})/SupportGroupContacts({relatedKey}) | WS-ModifySupportGroupResourceMap |
DELETE
| |
integration/api/odata/SupportGroups({key})/Notes({relatedKey}) | |
GET
| |
integration/api/odata/SupportGroups({key})/Notes | |
GET
| |
integration/api/odata/SupportGroups({key})/Notes | |
POST
| |
integration/api/odata/SupportGroups({key})/Notes | |
DELETE
| |
integration/api/odata/SupportGroups({key})/Notes({relatedKey}) | |
DELETE
| |
integration/api/odata/SupportGroups({key})/Notes({relatedKey}) | |
PATCH
| |
integration/api/odata/SupportGroups/In(Ids={ids}) | |
GET
| |
integration/api/odata/SupportGroups/NotIn(Ids={ids}) | |
GET
| |
SupportGroups Nested Properties
|
NestedProperty | Supported Method(s) |
---|
AssociatedSupportGroups |
BIND
POST
PATCH
|
SupportGroupContacts |
BIND
POST
PATCH
|
Verb(s) | Required Permission(s) | Link | Description |
---|
PUT | WS-ModifyTask | integration/api/odata/TaskInstances({key}) | |
POST | | integration/api/odata/TaskInstances | |
POST | | integration/api/odata/TaskInstances({key}) | |
PATCH | WS-ModifyTask | integration/api/odata/TaskInstances({key}) | |
GET | WS-ReadTask | integration/api/odata/TaskInstances | |
GET | WS-ReadTask | integration/api/odata/TaskInstances({key}) | |
TaskInstances Actions
|
Action | Required Permission(s) | Link | Description |
---|
MoveAssets | WS-ExecuteMoveAssets | integration/api/odata/TaskInstances({key})/MoveAssets(AssetIds={assetids}) | |
RecycleAssets | WS-ExecuteRecycleAssets | integration/api/odata/TaskInstances({key})/RecycleAssets(AssetIds={assetids}) | |
DecommissionAssets | WS-ExecuteDecommissionAssets | integration/api/odata/TaskInstances({key})/DecommissionAssets(AssetIds={assetids}) | |
SetStatus | WS-ModifyTask | integration/api/odata/TaskInstances({key})/SetStatus(Status={status}) | |
CreateAsset | | integration/api/odata/TaskInstances({key})/CreateAsset(Asset={asset}) | |
CreateAssets | WS-ExecuteCreateAssets | integration/api/odata/TaskInstances({key})/CreateAssets(AssetRowIndexes={assetrowindexes}) | |
RenameAssets | WS-ExecuteRenameAssets | integration/api/odata/TaskInstances({key})/RenameAssets(AssetIds={assetids}) | |
ModifyAssets | WS-ExecuteModifyAssets | integration/api/odata/TaskInstances({key})/ModifyAssets(AssetIds={assetids}) | |
CompleteAssets | WS-ExecuteCompleteAssets | integration/api/odata/TaskInstances({key})/CompleteAssets(AssetIds={assetids}) | |
UploadFile | WS-AddFile | integration/api/odata/TaskInstances({key})/UploadFile(File={file}) | |
DeleteFile | WS-ModifyFile | integration/api/odata/TaskInstances({key})/DeleteFile(FileName={filename}) | |
TaskInstances Functions
|
Function | Required Permission(s) | Link | Description |
---|
GetMyGroupsTasks | WS-ReadTask | integration/api/odata/TaskInstances/GetMyGroupsTasks | |
DownloadFile | WS-ReadFile | integration/api/odata/TaskInstances({key})/DownloadFile(FileName={filename}) | |
GetControlAssets | WS-ReadGetControlAssets | integration/api/odata/TaskInstances({key})/GetControlAssets(formControlId={formcontrolid}) | |
TaskInstances Custom Routes
|
CustomRoute | Required Permission(s) | Supported Method(s) | Description |
---|
integration/api/odata/TaskInstances({key})/Assignees({relatedKey}) | WS-ModifyAssignee |
POST
| |
integration/api/odata/TaskInstances({key})/Assignees({relatedKey}) | WS-ModifyAssignee |
DELETE
| |
integration/api/odata/TaskInstances({key})/Notes({relatedKey}) | |
GET
| |
integration/api/odata/TaskInstances({key})/Notes | |
GET
| |
integration/api/odata/TaskInstances({key})/Notes | |
POST
| |
integration/api/odata/TaskInstances({key})/Notes | |
DELETE
| |
integration/api/odata/TaskInstances({key})/Notes({relatedKey}) | |
DELETE
| |
integration/api/odata/TaskInstances({key})/Notes({relatedKey}) | |
PATCH
| |
integration/api/odata/TaskInstances | |
GET
| |
integration/api/odata/TaskInstances({key})/Files | |
DELETE
| |
integration/api/odata/TaskInstances({key})/Issues({relatedKey}) | WS-ReadTask |
GET
| |
integration/api/odata/TaskInstances({key})/Issues | WS-ReadTask |
GET
| |
integration/api/odata/TaskInstances({key})/Issues | WS-ModifyTask |
POST
| |
integration/api/odata/TaskInstances({key})/Issues({relatedKey})/Resolve | WS-ModifyTask, WS-ModifyIssue |
POST
| |
integration/api/odata/TaskInstances/In(Ids={ids}) | |
GET
| |
integration/api/odata/TaskInstances/NotIn(Ids={ids}) | |
GET
| |
TaskInstances Nested Properties
No nested properties
Verb(s) | Required Permission(s) | Link | Description |
---|
POST | WS-AddAuxiliaryMaterial | integration/api/odata/TransformerAuxiliaryMaterials | |
PATCH | WS-ModifyAuxiliaryMaterial | integration/api/odata/TransformerAuxiliaryMaterials({key}) | |
DELETE | WS-ModifyAuxiliaryMaterial | integration/api/odata/TransformerAuxiliaryMaterials({key}) | |
GET | WS-ReadAuxiliaryMaterial | integration/api/odata/TransformerAuxiliaryMaterials | |
GET | WS-ReadAuxiliaryMaterial | integration/api/odata/TransformerAuxiliaryMaterials({key}) | |
TransformerAuxiliaryMaterials Actions
|
Action | Required Permission(s) | Link | Description |
---|
Cancel | WS-ModifyAuxiliaryMaterial | integration/api/odata/TransformerAuxiliaryMaterials({key})/Cancel | |
Activate | WS-ModifyAuxiliaryMaterial | integration/api/odata/TransformerAuxiliaryMaterials({key})/Activate | Function that will move a material in Active status. |
Deactivate | WS-ModifyAuxiliaryMaterial | integration/api/odata/TransformerAuxiliaryMaterials({key})/Deactivate | Function that will move a material in Inactive status. |
UploadFile | WS-AddFile | integration/api/odata/TransformerAuxiliaryMaterials({key})/UploadFile(File={file}) | |
DeleteFile | WS-ModifyFile | integration/api/odata/TransformerAuxiliaryMaterials({key})/DeleteFile(FileName={filename}) | |
TransformerAuxiliaryMaterials Functions
|
Function | Required Permission(s) | Link | Description |
---|
DownloadFile | WS-ReadFile | integration/api/odata/TransformerAuxiliaryMaterials({key})/DownloadFile(FileName={filename}) | |
GetAuditLogData | WS-ReadAuditLog | integration/api/odata/TransformerAuxiliaryMaterials({key})/GetAuditLogData | Function used to export all audit information for a specific entity. Please use the following Content-Type:application/vnd.openxmlformats-officedocument.spreadsheetml.sheet for file download |
TransformerAuxiliaryMaterials Custom Routes
|
CustomRoute | Required Permission(s) | Supported Method(s) | Description |
---|
integration/api/odata/TransformerAuxiliaryMaterials/In(Ids={ids}) | |
GET
| |
integration/api/odata/TransformerAuxiliaryMaterials/NotIn(Ids={ids}) | |
GET
| |
integration/api/odata/TransformerAuxiliaryMaterials({key})/Files | |
DELETE
| |
TransformerAuxiliaryMaterials Nested Properties
No nested properties
Verb(s) | Required Permission(s) | Link | Description |
---|
POST | WS-AddUPSMaterial | integration/api/odata/UPSMaterials | |
PATCH | WS-ModifyUPSMaterial | integration/api/odata/UPSMaterials({key}) | |
DELETE | WS-ModifyUPSMaterial | integration/api/odata/UPSMaterials({key}) | |
GET | WS-ReadUPSMaterial | integration/api/odata/UPSMaterials | |
GET | WS-ReadUPSMaterial | integration/api/odata/UPSMaterials({key}) | |
UPSMaterials Actions
|
Action | Required Permission(s) | Link | Description |
---|
Cancel | WS-ModifyUPSMaterial | integration/api/odata/UPSMaterials({key})/Cancel | |
Activate | WS-ModifyUPSMaterial | integration/api/odata/UPSMaterials({key})/Activate | Function that will move a material in Active status. |
Deactivate | WS-ModifyUPSMaterial | integration/api/odata/UPSMaterials({key})/Deactivate | Function that will move a material in Inactive status. |
UploadFile | WS-AddFile | integration/api/odata/UPSMaterials({key})/UploadFile(File={file}) | |
DeleteFile | WS-ModifyFile | integration/api/odata/UPSMaterials({key})/DeleteFile(FileName={filename}) | |
UPSMaterials Functions
|
Function | Required Permission(s) | Link | Description |
---|
DownloadFile | WS-ReadFile | integration/api/odata/UPSMaterials({key})/DownloadFile(FileName={filename}) | |
GetAuditLogData | WS-ReadAuditLog | integration/api/odata/UPSMaterials({key})/GetAuditLogData | Function used to export all audit information for a specific entity. Please use the following Content-Type:application/vnd.openxmlformats-officedocument.spreadsheetml.sheet for file download |
UPSMaterials Custom Routes
|
CustomRoute | Required Permission(s) | Supported Method(s) | Description |
---|
integration/api/odata/UPSMaterials/In(Ids={ids}) | |
GET
| |
integration/api/odata/UPSMaterials/NotIn(Ids={ids}) | |
GET
| |
integration/api/odata/UPSMaterials({key})/Files | |
DELETE
| |
UPSMaterials Nested Properties
No nested properties
Verb(s) | Required Permission(s) | Link | Description |
---|
POST | WS-ModifyUPS | integration/api/odata/UPSs({key}) | |
POST | WS-AddUPS | integration/api/odata/UPSs | |
PATCH | WS-ModifyUPS | integration/api/odata/UPSs({key}) | |
DELETE | WS-ModifyUPS | integration/api/odata/UPSs({key}) | |
GET | WS-ReadUPS | integration/api/odata/UPSs | |
GET | WS-ReadUPS | integration/api/odata/UPSs({key}) | |
UPSs Actions
|
Action | Required Permission(s) | Link | Description |
---|
BeginMove | WS-PlanRecycleUPS, WS-PlanDecommissionUPS | integration/api/odata/UPSs({key})/BeginMove(RelocateType={relocatetype}) | Function that is used to move the selected asset in a planned state, Moving, Recycling or Decommissioning, depending on the RelocateType provided as parameter. The response contains the Planned AssetId. |
CancelMove | WS-CancelRecycleUPS, WS-CancelDecommissionUPS | integration/api/odata/UPSs({key})/CancelMove | Function that is used to cancel planned action. The selected asset will become Active/Operational. |
CompleteMove | WS-CompleteRecycleUPS, WS-CompleteDecommissionUPS | integration/api/odata/UPSs({key})/CompleteMove | Function that is used to finish planned action. The selected asset will become Active/Operational, Recycled/Available or Decommissioned/Decommissioned, depending on the Planned entity type (Move, Recycle or Deccommission). |
DirectMove | WS-SetLocationUPS | integration/api/odata/UPSs({key})/DirectMove(RelocateType={relocatetype}, LocationGroupID={locationgroupid}) | Function that is used to directly move an asset to a new location in a final state. |
CompleteCreation | WS-ModifyUPS | integration/api/odata/UPSs({key})/CompleteCreation | Function that moves an asset from Planned/(Pre)Procurement to Active/Operational. |
SetMaterial | | integration/api/odata/UPSs({key})/SetMaterial(NewMaterialID={newmaterialid}) | Function that is used to change the material on an existing asset. This action is only supported for Receptacles and Power Strips. |
AddRealTimeValues | WS-AddAssetRealtimeData | integration/api/odata/UPSs({key})/AddRealTimeValues(RealTimeInfo={realtimeinfo}, RealTimeValue={realtimevalue}) | Adds a provider specfic recorded real-time value against an asset or its associated outlet. Custom metrics are only allowed on assets whereas load, power and voltage metrics are allowed against assets, outlets or their relevant phases. |
AddNetworkAsset | WS-ReadNetworkConnection,WS-AddNetworkConnection | integration/api/odata/UPSs({key})/AddNetworkAsset(NetworkAssetId={networkassetid}) | Function that is adding the selected asset in the list of available asset to be used in network connections. The mapping between the two assets is created by providing the NetworkAssetId parameter in the BODY, NetworkAssetId representing the AssetID of the asset to be added in the list of available assets. |
RemoveNetworkAsset | WS-ModifyNetworkConnection | integration/api/odata/UPSs({key})/RemoveNetworkAsset(NetworkAssetId={networkassetid}, NetworkLinkerType={networklinkertype}) | Function that removes an asset from the association list of available asset to be used in network connections. |
UploadFile | WS-AddFile | integration/api/odata/UPSs({key})/UploadFile(File={file}) | |
DeleteFile | WS-ModifyFile | integration/api/odata/UPSs({key})/DeleteFile(FileName={filename}) | |
UPSs Functions
|
Function | Required Permission(s) | Link | Description |
---|
GetTotalSystemPowerConsumption | WS-ReadUPS | integration/api/odata/UPSs({key})/GetTotalSystemPowerConsumption | Function that returns the TotalSystemPowerConsumption for the selected asset. |
GetRealTimePowerInfo | WS-ReadUPS | integration/api/odata/UPSs({key})/GetRealTimePowerInfo | |
GetDiscoveryAssetPage | WS-ReadUPS | integration/api/odata/UPSs({key})/GetDiscoveryAssetPage | Function that returns a collection of entities of type Nlyte.Model.AssetMapping. Used to determine external providers. |
RecordModifiedInfo | WS-ReadUPS | integration/api/odata/UPSs({key})/RecordModifiedInfo | Function that returns an entity of type Nlyte.Model.AuditLogInfo and provides information regarding last modifications against the current asset |
GetMountedChildAssets | | integration/api/odata/UPSs({key})/GetMountedChildAssets(IncludeHosts={includehosts}, IncludeCards={includecards}) | Function that returns a collection of entities of type Nlyte.Model.MountedAssetSummary representing the list of mounted assets in the provided asset. The function is called as follows: Assets(AssetID)/GetMountedChildAssets(IncludeHosts=true,IncludeCards=true) where AssetID is the parent for which the children are retrieved. |
GetDistributorsWithFreeOutlets | WS-ReadAssetToAssetMapping | integration/api/odata/UPSs({key})/GetDistributorsWithFreeOutlets(SearchTerm={searchterm}, SearchTermOption={searchtermoption}, LocationDepth={locationdepth}, MaterialTypeID={materialtypeid}, MaterialSubtypeID={materialsubtypeid}) | Function that returns a collection of entities of type Nlyte.Model.Distributor representing available power suppliers. |
SearchAssetNetworkPortLinkage | WS-ReadNetworkConnection | integration/api/odata/UPSs({key})/SearchAssetNetworkPortLinkage(SearchTerm={searchterm}, SearchTermOption={searchtermoption}, CabinetMountingStatus={cabinetmountingstatus}, LocationTarget={locationtarget}, NetworkTypes={networktypes}, PortLocation={portlocation}) | Function that returns a collection of entities of type Nlyte.Model.AssetNetworkPortLinkage representing available assets to be used in network connections. |
GetRealTimeValues | WS-ReadAssetRealtimeData | integration/api/odata/UPSs({key})/GetRealTimeValues | Function that returns a collection of entities of type Nlyte.Model.RealTimeValue. |
GetAssetSummaries | | integration/api/odata/UPSs({key})/GetAssetSummaries(OwnedPeripherals={ownedperipherals}, IncludeHosts={includehosts}) | |
GetNetworkCardPortsInfo | WS-ReadNetworkConnection | integration/api/odata/UPSs({key})/GetNetworkCardPortsInfo | Returns an object of type Nlyte.Model.NetworkResults having information about Copper and Fiber Ports |
GetNetworkCardPortConnections | WS-ReadNetworkConnection | integration/api/odata/UPSs({key})/GetNetworkCardPortConnections | Returns an object of type Nlyte.Model.NetworkResults having information about Copper and Fiber Port connections |
GetNetworkAssetSummary | WS-ReadNetworkConnection | integration/api/odata/UPSs({key})/GetNetworkAssetSummary | Returns an object of type Nlyte.Model.NetworkResults having information about the networkable assets. |
ListPowerConsumers | | integration/api/odata/UPSs({key})/ListPowerConsumers | Function that returns a collection of Nlyte.Model.Graph entities. Used to identify available Output Connector used in power connections. |
SupportsPlannedMove | | integration/api/odata/UPSs({key})/SupportsPlannedMove | |
GetTotalSystemWeight | | integration/api/odata/UPSs({key})/GetTotalSystemWeight | Function that returns the TotalSystemWeight for the selected asset. |
GetMountedOnAssetID | | integration/api/odata/UPSs({key})/GetMountedOnAssetID | |
GetAssetsReportData | WS-ReadNetwork,WS-ReadCabinet,WS-ReadPeripheral,WS-ReadKVMSwitch,WS-ReadServer,WS-ReadPDU,WS-ReadPowerStrip,WS-ReadAirConditioning,WS-ReadReceptacle,WS-ReadChassis,WS-ReadUPS,WS-ReadAuxiliary,WS-ReadStaticSwitch,WS-ReadServerHost | integration/api/odata/UPSs/GetAssetsReportData(assetIds={assetids}) | |
DownloadFile | WS-ReadFile | integration/api/odata/UPSs({key})/DownloadFile(FileName={filename}) | |
GetAuditLogData | WS-ReadAuditLog | integration/api/odata/UPSs({key})/GetAuditLogData | Function used to export all audit information for a specific entity. Please use the following Content-Type:application/vnd.openxmlformats-officedocument.spreadsheetml.sheet for file download |
UPSs Custom Routes
|
CustomRoute | Required Permission(s) | Supported Method(s) | Description |
---|
integration/api/odata/UPSs({key})/Wires | |
GET
| |
integration/api/odata/UPSs({key})/Notes({relatedKey}) | |
GET
| |
integration/api/odata/UPSs({key})/Notes | |
GET
| |
integration/api/odata/UPSs({key})/Notes | |
POST
| |
integration/api/odata/UPSs({key})/Notes | |
DELETE
| |
integration/api/odata/UPSs({key})/Notes({relatedKey}) | |
DELETE
| |
integration/api/odata/UPSs({key})/Notes({relatedKey}) | |
PATCH
| |
integration/api/odata/UPSs({key})/Utilities | |
GET
| |
integration/api/odata/UPSs({key})/Utilities({relatedKey}) | |
GET
| |
integration/api/odata/UPSs({key})/Utilities({relatedKey}) | |
DELETE
| |
integration/api/odata/UPSs({key})/Graphs | |
GET
| |
integration/api/odata/UPSs({key})/Graphs({relatedKey}) | |
GET
| |
integration/api/odata/UPSs({key})/Graphs({relatedKey}) | |
PATCH
| |
integration/api/odata/UPSs({key})/Graphs | |
POST
| |
integration/api/odata/UPSs({key})/Graphs({relatedKey}) | |
DELETE
| |
integration/api/odata/UPSs({key})/GetAvailableCabinetUs(CabinetID={cabinetId}) | WS-ReadCabinet |
GET
| |
integration/api/odata/UPSs({key})/GetServiceRequests | |
GET
| |
integration/api/odata/UPSs({key})/CustomFields | WS-ReadCustomFieldUPS |
GET
| |
integration/api/odata/UPSs({key})/CustomFields | WS-ModifyCustomFieldUPS |
POST
| |
integration/api/odata/UPSs({key})/CustomFields({relatedKey}) | WS-ModifyCustomFieldUPS |
PATCH
| |
integration/api/odata/UPSs({key})/CustomFields({relatedKey}) | WS-ModifyCustomFieldUPS |
DELETE
| |
integration/api/odata/UPSs({key})/Warranty | WS-ReadUPS |
GET
| |
integration/api/odata/UPSs({key})/Warranty | WS-ModifyUPS |
POST
| |
integration/api/odata/UPSs({key})/Warranty | WS-ModifyUPS |
PATCH
| |
integration/api/odata/UPSs({key})/Warranty | WS-ModifyUPS |
DELETE
| |
integration/api/odata/UPSs({key})/Maintenance | WS-ReadUPS |
GET
| |
integration/api/odata/UPSs({key})/Maintenance | WS-ModifyUPS |
POST
| |
integration/api/odata/UPSs({key})/Maintenance | WS-ModifyUPS |
PATCH
| |
integration/api/odata/UPSs({key})/Maintenance | WS-ModifyUPS |
DELETE
| |
integration/api/odata/UPSs({key})/AssetMounting | |
GET
| |
integration/api/odata/UPSs({key})/Ownership | WS-ReadBusinessGroupAssetMap |
GET
| |
integration/api/odata/UPSs({key})/Ownership({relatedKey}) | WS-ReadBusinessGroupAssetMap |
GET
| |
integration/api/odata/UPSs({key})/Ownership | WS-AddBusinessGroupAssetMap |
POST
| |
integration/api/odata/UPSs({key})/Ownership({relatedKey}) | WS-ModifyBusinessGroupAssetMap |
PATCH
| |
integration/api/odata/UPSs({key})/Ownership({relatedKey}) | WS-ModifyBusinessGroupAssetMap |
DELETE
| |
integration/api/odata/UPSs({key})/Support | WS-ReadSupportGroupAssetMap |
GET
| |
integration/api/odata/UPSs({key})/Support({relatedKey}) | WS-ReadSupportGroupAssetMap |
GET
| |
integration/api/odata/UPSs({key})/Support | WS-AddSupportGroupAssetMap |
POST
| |
integration/api/odata/UPSs({key})/Support({relatedKey}) | WS-ModifySupportGroupAssetMap |
PATCH
| |
integration/api/odata/UPSs({key})/Support({relatedKey}) | WS-ModifySupportGroupAssetMap |
DELETE
| |
integration/api/odata/UPSs({key})/AssociatedAssets({relatedKey}) | |
DELETE
| |
integration/api/odata/UPSs({key})/AssociatedAssets({relatedKey})/Notes({nestedRelatedKey}) | |
GET
| |
integration/api/odata/UPSs({key})/AssociatedAssets({relatedKey})/Notes | |
GET
| |
integration/api/odata/UPSs({key})/AssociatedAssets({relatedKey})/Notes({nestedRelatedKey}) | |
PATCH
| |
integration/api/odata/UPSs({key})/AssociatedAssets({relatedKey})/Notes | |
POST
| |
integration/api/odata/UPSs({key})/AssociatedAssets({relatedKey})/Notes | |
DELETE
| |
integration/api/odata/UPSs({key})/AssociatedAssets({relatedKey})/Notes({nestedRelatedKey}) | |
DELETE
| |
integration/api/odata/UPSs/In(Ids={ids}) | |
GET
| |
integration/api/odata/UPSs/NotIn(Ids={ids}) | |
GET
| |
integration/api/odata/UPSs({key})/Files | |
DELETE
| |
UPSs Nested Properties
|
NestedProperty | Supported Method(s) |
---|
Ownership |
BIND
POST
PATCH
|
Support |
BIND
POST
PATCH
|
CustomFields |
POST
PATCH
|
Maintenance |
POST
PATCH
|
Warranty |
POST
PATCH
|
AssetIPAddressMap |
POST
PATCH
|
LocationGroup | |
AssociatedAssets |
BIND
|
Utilities |
POST
PATCH
|
Graphs |
POST
PATCH
|
UMounting |
POST
PATCH
|
Verb(s) | Required Permission(s) | Link | Description |
---|
GET | | integration/api/odata/UserAccountPermissions | |
GET | | integration/api/odata/UserAccountPermissions({key}) | |
UserAccountPermissions Actions
No actions
UserAccountPermissions Functions
No functions
UserAccountPermissions Custom Routes
|
CustomRoute | Required Permission(s) | Supported Method(s) | Description |
---|
integration/api/odata/UserAccountPermissions/In(Ids={ids}) | |
GET
| |
integration/api/odata/UserAccountPermissions/NotIn(Ids={ids}) | |
GET
| |
UserAccountPermissions Nested Properties
No nested properties
Verb(s) | Required Permission(s) | Link | Description |
---|
GET | | integration/api/odata/UserAccounts | Returns user account data for currently-logged-in user |
GET | | integration/api/odata/UserAccounts({key}) | |
UserAccounts Actions
No actions
UserAccounts Functions
No functions
UserAccounts Custom Routes
|
CustomRoute | Required Permission(s) | Supported Method(s) | Description |
---|
integration/api/odata/UserAccounts/In(Ids={ids}) | |
GET
| |
integration/api/odata/UserAccounts/NotIn(Ids={ids}) | |
GET
| |
UserAccounts Nested Properties
No nested properties
Verb(s) | Required Permission(s) | Link | Description |
---|
GET | | integration/api/odata/UserEffectivePermissions | |
GET | | integration/api/odata/UserEffectivePermissions({key}) | |
UserEffectivePermissions Actions
No actions
UserEffectivePermissions Functions
No functions
UserEffectivePermissions Custom Routes
No custom routes
UserEffectivePermissions Nested Properties
No nested properties
Verb(s) | Required Permission(s) | Link | Description |
---|
GET | | integration/api/odata/UserGroupPermissions | |
GET | | integration/api/odata/UserGroupPermissions({key}) | |
UserGroupPermissions Actions
No actions
UserGroupPermissions Functions
No functions
UserGroupPermissions Custom Routes
|
CustomRoute | Required Permission(s) | Supported Method(s) | Description |
---|
integration/api/odata/UserGroupPermissions/In(Ids={ids}) | |
GET
| |
integration/api/odata/UserGroupPermissions/NotIn(Ids={ids}) | |
GET
| |
UserGroupPermissions Nested Properties
No nested properties
Verb(s) | Required Permission(s) | Link | Description |
---|
GET | WS-ReadUtility | integration/api/odata/Utilities | |
GET | WS-ReadUtility | integration/api/odata/Utilities({key}) | |
Utilities Actions
No actions
Utilities Functions
No functions
Utilities Custom Routes
|
CustomRoute | Required Permission(s) | Supported Method(s) | Description |
---|
integration/api/odata/Utilities/In(Ids={ids}) | |
GET
| |
integration/api/odata/Utilities/NotIn(Ids={ids}) | |
GET
| |
Utilities Nested Properties
No nested properties
Verb(s) | Required Permission(s) | Link | Description |
---|
DELETE | | integration/api/odata/WorkingHours({key}) | |
POST | | integration/api/odata/WorkingHours | |
POST | | integration/api/odata/WorkingHours({key}) | |
PATCH | | integration/api/odata/WorkingHours({key}) | |
GET | | integration/api/odata/WorkingHours | |
GET | | integration/api/odata/WorkingHours({key}) | |
WorkingHours Actions
No actions
WorkingHours Functions
No functions
WorkingHours Custom Routes
|
CustomRoute | Required Permission(s) | Supported Method(s) | Description |
---|
integration/api/odata/WorkingHours/In(Ids={ids}) | |
GET
| |
integration/api/odata/WorkingHours/NotIn(Ids={ids}) | |
GET
| |
WorkingHours Nested Properties
No nested properties
Complex Types
Property | Type | Nullable | Read-Only | Description |
---|
ActiveForeignProjectID | Edm.Int32 | false |
false
| |
ActiveForeignProjectName | Edm.String |
true
|
false
| |
AirflowTypeID | Nlyte.Model.AirflowTypeEnum |
true
|
false
| Selected air flow, from the available values defined in the administration area |
AllocatedCabinetAssetID | Edm.Int32 | false |
false
| |
AllocatedCabinetAssetNumber | Edm.Int32 | false |
false
| |
AllocatedCabinetName | Edm.String |
true
|
false
| |
AllocatedDuplicateLocationGroupName | Edm.String |
true
|
false
| The unique location name, having the name as a concatenation of last hierarchical location names. |
AllocatedLocationGroupID | Edm.Int32 | false |
false
| Foreign key identifying the new location after allocation |
AllocatedU | Edm.Int32 | false |
false
| |
AssetID | Edm.Int32 | false |
false
| |
BusinessGroupID | Edm.Int32 |
true
|
false
| |
CabinetUsageID | Edm.Int32 |
true
|
false
| |
CardConnectionsRequired | Edm.Boolean | false |
false
| |
CompatibleNetworksRequired | Edm.Boolean | false |
false
| |
ConnectCardConnections | Edm.Boolean | false |
false
| |
ConnectKvm | Edm.Boolean | false |
false
| |
ConnectPowerConnections | Edm.Boolean | false |
false
| |
CurrentCabinetAssetID | Edm.Int32 | false |
false
| |
CurrentCabinetAssetNumber | Edm.Int32 | false |
false
| |
CurrentCabinetName | Edm.String |
true
|
false
| |
CurrentDuplicateLocationGroupName | Edm.String |
true
|
false
| The unique current location name, having the name as a concatenation of last hierarchical location names |
CurrentLocationGroupID | Edm.Int32 | false |
false
| Foreign key identifying the current location of the asset planned to allocation. |
DataTypeRequired | Edm.Boolean | false |
false
| |
DiversePowerRequired | Edm.Boolean | false |
false
| |
Errors | Collection(Edm.String) |
true
|
false
| |
FindExactMatchForUSpace | Edm.Boolean | false |
false
| |
ID | Edm.Int32 | false |
false
| |
IncludeInAutoAllocation | Edm.Boolean | false |
false
| |
KvmSwitchRequired | Edm.Boolean | false |
false
| |
MaterialName | Edm.String |
true
|
false
| |
MaterialNumber | Edm.Int32 | false |
false
| |
MaterialSubTypeID | Edm.Int32 | false |
false
| |
MaterialTypeID | Edm.Int32 | false |
false
| |
MaterialTypeName | Edm.String |
true
|
false
| |
MaterialUheight | Edm.Int32 | false |
false
| |
MountingTypeID | Nlyte.Model.MountingTypeEnum |
true
|
false
| |
Name | Edm.String |
true
|
false
| |
Number | Edm.Int32 | false |
false
| |
Order | Edm.Int32 | false |
false
| |
PatchingNetworkSubTypeID | Nlyte.Model.NetworkSubTypeEnum |
true
|
false
| Selected network sub-type used in search during AutoAllocate for network patching. Default = PatchPanel |
PlannedAssetID | Edm.Int32 | false |
false
| |
PlannedName | Edm.String |
true
|
false
| |
PlannedNumber | Edm.Int32 | false |
false
| |
PowerConnectionsRequired | Edm.Boolean | false |
false
| |
ProjectItemActionID | Nlyte.Model.ProjectItemActionEnum | false |
false
| |
ProjectItemHistoryID | Edm.Int32 |
true
|
false
| |
ProjectItemStatusID | Nlyte.Model.ProjectItemStatusEnum |
true
|
false
| |
ProjectItemTypeID | Edm.Int32 | false |
false
| |
RequiredUHeight | Edm.Int32 | false |
false
| |
ReturnCabinetsLinkedToSelectedBusinessGroupOnly | Edm.Boolean | false |
false
| |
StatusID | Edm.Int32 | false |
false
| |
TargetDuplicateLocationGroupName | Edm.String |
true
|
false
| The unique planned location name, having the name as a concatenation of last hierarchical location names. |
TargetLocationGroupID | Edm.Int32 | false |
false
| Foreign key identifying the planned location in which the asset will be allocated |
TargetLocationGroupName | Edm.String |
true
|
false
| The planned location name |
TotalHeat | Edm.Decimal | false |
false
| |
TotalUheight | Edm.Int32 | false |
false
| |
TotalWeight | Edm.Double | false |
false
| |
UseAirflow | Edm.Boolean | false |
false
| |
UseBusinessGroups | Edm.Boolean | false |
false
| |
UseCabinetUsage | Edm.Boolean | false |
false
| |
UseCardConnections | Edm.Boolean | false |
false
| |
UseCompatibleNetworks | Edm.Boolean | false |
false
| |
UseDataType | Edm.Boolean | false |
false
| |
UseDiversePower | Edm.Boolean | false |
false
| |
UseKvmSwitch | Edm.Boolean | false |
false
| |
UseMountingType | Edm.Boolean | false |
false
| |
UsePatchingNetworkSubType | Edm.Boolean | false |
false
| |
UsePowerConnections | Edm.Boolean | false |
false
| |
UseTotalHeat | Edm.Boolean | false |
false
| |
UseTotalWeight | Edm.Boolean | false |
false
| |
UseWarningPolicies | Edm.Boolean | false |
false
| |
Warnings | Collection(Edm.String) |
true
|
false
| |
Property | Type | Nullable | Read-Only | Description |
---|
AirFlowTypeId | Nlyte.Model.AirflowTypeEnum |
true
|
false
| Selected air flow, from the available values defined in the administration area |
MountingTypeId | Nlyte.Model.MountingTypeEnum |
true
|
false
| |
RequiresDiversePower | Edm.Boolean | false |
false
| |
RequiresKvmSwitch | Edm.Boolean | false |
false
| |
RequiresPatchConnections | Edm.Boolean | false |
false
| |
RequiresPortDataTypeConnections | Edm.Boolean | false |
false
| |
TotalUSpaceRequired | Edm.Int32 | false |
false
| |
UseCardConnections | Edm.Boolean | false |
false
| |
UsePatchingNetworkSubType | Edm.Boolean | false |
false
| |
Property | Type | Nullable | Read-Only | Description |
---|
ActiveAssetId | Edm.Int32 | false |
false
| |
PlannedAssetId | Edm.Int32 |
true
|
false
| |
Property | Type | Nullable | Read-Only | Description |
---|
CabinetAssetName | Edm.String |
true
|
false
| |
DuplicateLocationGroupName | Edm.String |
true
|
false
| The unique location name, having the name as a concatenation of last hierarchical location names. |
FreeCopperPorts | Edm.Int32 |
true
|
false
| |
FreeFibreOpticPorts | Edm.Int32 |
true
|
false
| |
FreeUndefinedPorts | Edm.Int32 |
true
|
false
| |
LocationGroupID | Edm.Int32 |
true
|
false
| Foreign key identifying the asset location |
LocationGroupName | Edm.String |
true
|
false
| The location name |
MaterialName | Edm.String |
true
|
false
| |
MountingType | Edm.String |
true
|
false
| |
MountingTypeID | Edm.Int32 |
true
|
false
| |
NetworkAssetID | Edm.Int32 | false |
false
| |
NetworkAssetName | Edm.String |
true
|
false
| |
NetworkAssetNumber | Edm.Int32 | false |
false
| |
NetworkSpeedMbps | Edm.Int32 |
true
|
false
| Network speed in Mbps |
NetworkTypeID | Edm.Int32 |
true
|
false
| |
OperationalStatusID | Edm.Int32 |
true
|
false
| Reflects the current state and/or planned future state. Together with the Record Status, they give the user the exact life-cycle status. |
RecordStatus | Edm.Int32 |
true
|
false
| |
RecordStatusDescription | Edm.String |
true
|
false
| |
TotalCopperPorts | Edm.Int32 |
true
|
false
| |
TotalFibreOpticPorts | Edm.Int32 |
true
|
false
| |
TotalUndefinedPorts | Edm.Int32 |
true
|
false
| |
Property | Type | Nullable | Read-Only | Description |
---|
AssetID | Edm.Int32 | false |
false
| |
Colour | Edm.String |
true
|
false
| |
Value | Edm.String |
true
|
false
| |
Property | Type | Nullable | Read-Only | Description |
---|
AssetID | Edm.Int32 |
true
|
false
| |
AssetName | Edm.String |
true
|
false
| |
AssetNumber | Edm.Int32 |
true
|
false
| |
AssetTypeDetail | Edm.String | false |
false
| |
CabinetUsageID | Edm.Int32 |
true
|
false
| |
CustomField | Collection(Nlyte.Model.KeyValuePair_2OfString_String) |
true
|
false
| |
FunctionalUseID | Edm.Int32 |
true
|
false
| |
HeatingLimit | Edm.Double | false |
false
| |
HeatThreshold | Edm.Double | false |
false
| |
LocationGroupID | Edm.Int32 | false |
false
| |
MaterialName | Edm.String | false |
false
| |
MaterialNumber | Edm.Int32 |
true
|
false
| |
MaterialSubTypeID | Edm.Int32 |
true
|
false
| |
MaterialTypeID | Edm.Int32 | false |
false
| |
OperationalStatus | Nlyte.Model.OperationalStatusEnum | false |
false
| |
OperationalUseID | Edm.Int32 |
true
|
false
| |
ParentAssetID | Edm.Int32 |
true
|
false
| |
PONumber | Edm.String |
true
|
false
| |
PRNumber | Edm.String |
true
|
false
| |
RecordStatus | Nlyte.Model.RecordStatusEnum | false |
false
| |
RFIDTag | Edm.String |
true
|
false
| Damaged RFIDTag |
SAPAssetNumber | Edm.String |
true
|
false
| |
SerialNumber | Edm.String |
true
|
false
| |
Tag | Edm.String |
true
|
false
| |
Property | Type | Nullable | Read-Only | Description |
---|
AirflowType | Nlyte.Model.AirflowTypeEnum | false |
false
| |
AssetName | Edm.String |
true
|
false
| The cabinet asset name |
AvailableUHeight | Edm.String |
true
|
false
| |
CabinetAssetId | Edm.Int32 | false |
false
| |
CabinetUsageId | Edm.Int32 | false |
false
| |
DuplicateLocationGroupName | Edm.String |
true
|
false
| The unique location name, having the name as a concatenation of last hierarchical location names. |
HeatThreshold | Edm.Double | false |
false
| |
LocationGroupId | Edm.Int32 | false |
false
| Foreign key identifying the location |
MaterialId | Edm.Int32 | false |
false
| The key that identifies the material from which the cabinet for auto-allocation was created. |
MountingType | Nlyte.Model.MountingTypeEnum | false |
false
| |
Rank | Edm.Int32 | false |
false
| |
RemainingCooling | Edm.Double | false |
false
| |
TotalHeatUsage | Edm.Double | false |
false
| |
Property | Type | Nullable | Read-Only | Description |
---|
MessageCode | Edm.String |
true
|
false
| |
Result | Edm.Boolean | false |
false
| |
Property | Type | Nullable | Read-Only | Description |
---|
Property | Type | Nullable | Read-Only | Description |
---|
Property | Type | Nullable | Read-Only | Description |
---|
AssetID | Edm.Int32 | false |
false
| |
AssetName | Edm.String |
true
|
false
| |
AssetNumber | Edm.Int32 | false |
false
| |
CabinetAssetID | Edm.Int32 |
true
|
false
| |
CabinetAssetName | Edm.String |
true
|
false
| |
ChassisAssetID | Edm.Int32 |
true
|
false
| |
ChassisAssetName | Edm.String |
true
|
false
| |
Columns | Edm.Int32 | false |
false
| |
DuplicateLocationGroupName | Edm.String |
true
|
false
| The unique location name, having the name as a concatenation of last hierarchical location names. |
LocationGroupID | Edm.Int32 | false |
false
| Foreign key identifying the asset location |
OperationalStatus | Nlyte.Model.OperationalStatusEnum | false |
false
| Reflects the current state and/or planned future state. Together with the Record Status, they give the user the exact life-cycle status. |
RecordStatus | Nlyte.Model.RecordStatusEnum | false |
false
| |
Rows | Edm.Int32 | false |
false
| |
Property | Type | Nullable | Read-Only | Description |
---|
CabinetAssetID | Edm.Int32 |
true
|
false
| |
CabinetAssetName | Edm.String |
true
|
false
| |
ChassisAssetID | Edm.Int32 | false |
false
| |
ChassisAssetName | Edm.String |
true
|
false
| |
ChassisAssetNumber | Edm.Int32 | false |
false
| |
DuplicateLocationGroupName | Edm.String |
true
|
false
| The unique location name, having the name as a concatenation of last hierarchical location names. |
FreeSlots | Edm.Int32 | false |
false
| |
LocationGroupID | Edm.Int32 | false |
false
| Foreign key identifying the asset location |
MaterialID | Edm.Int32 | false |
false
| The key that identifies the material from which the asset was created. |
MaterialName | Edm.String |
true
|
false
| |
OperationalStatus | Nlyte.Model.OperationalStatusEnum | false |
false
| Reflects the current state and/or planned future state. Together with the Record Status, they give the user the exact life-cycle status. |
RecordStatus | Nlyte.Model.RecordStatusEnum | false |
false
| |
Property | Type | Nullable | Read-Only | Description |
---|
Id | Edm.Int32 | false |
false
| |
Value | Edm.String |
true
|
false
| |
Property | Type | Nullable | Read-Only | Description |
---|
AssetID | Edm.Int32 | false |
false
| |
AssetName | Edm.String |
true
|
false
| |
AssetNumber | Edm.Int32 | false |
false
| |
AvailableOutputs | Edm.Int32 | false |
false
| |
CabinetAssetId | Edm.Int32 |
true
|
false
| |
CabinetAssetName | Edm.String |
true
|
false
| |
DuplicateLocationGroupName | Edm.String |
true
|
false
| The unique location name, having the name as a concatenation of last hierarchical location names. |
LocationGroupID | Edm.Int32 | false |
false
| Foreign key identifying the asset location |
MaterialID | Edm.Int32 | false |
false
| |
MaterialName | Edm.String |
true
|
false
| |
MaterialSubTypeID | Edm.Int32 | false |
false
| |
MaterialTypeID | Edm.Int32 | false |
false
| |
OperationalStatus | Nlyte.Model.OperationalStatusEnum | false |
false
| |
RecordStatus | Nlyte.Model.RecordStatusEnum | false |
false
| |
SupplierAssetCount | Edm.Int32 |
true
|
false
| |
SupplierAssetName | Edm.String |
true
|
false
| |
SupplierIsAccessible | Edm.Int32 |
true
|
false
| |
SupplierMaterialType | Edm.Int32 |
true
|
false
| |
SupplierMaterialTypeName | Edm.String |
true
|
false
| |
SupplierMaterialTypesCount | Edm.Int32 |
true
|
false
| |
TotalOutputs | Edm.Int32 | false |
false
| |
Property | Type | Nullable | Read-Only | Description |
---|
code | Edm.String |
true
|
false
| |
message | Edm.String |
true
|
false
| |
Property | Type | Nullable | Read-Only | Description |
---|
Property | Type | Nullable | Read-Only | Description |
---|
Property | Type | Nullable | Read-Only | Description |
---|
Property | Type | Nullable | Read-Only | Description |
---|
Key | Edm.Int32 | false |
false
| |
Value | Edm.String |
true
|
false
| |
Property | Type | Nullable | Read-Only | Description |
---|
Property | Type | Nullable | Read-Only | Description |
---|
LinkedRecordCount | Edm.Int32 | false |
false
| |
MaterialTypeId | Edm.Int32 | false |
false
| |
MaterialTypeName | Edm.String |
true
|
false
| |
Property | Type | Nullable | Read-Only | Description |
---|
AssetId | Edm.Int32 | false |
false
| |
AssetName | Edm.String |
true
|
false
| |
AssetNumber | Edm.Int32 | false |
false
| |
CabinetAssetId | Edm.Int32 |
true
|
false
| Foreign key identifying the asset of type cabinet, in which the current asset is mounted.. |
CabinetAssetName | Edm.String |
true
|
false
| |
CabinetMountingSideId | Edm.Int32 |
true
|
false
| |
CabinetOrientationId | Edm.Int32 |
true
|
false
| |
CabinetPlacementId | Edm.Int32 |
true
|
false
| |
CabinetU | Edm.Int32 |
true
|
false
| Property providing the cabinet U details. |
ChassisMountingSideId | Edm.Int32 |
true
|
false
| |
ChassisSlotColumn | Edm.Int32 |
true
|
false
| |
ChassisSlotRow | Edm.Int32 |
true
|
false
| |
HasChildren | Edm.Boolean | false |
false
| |
LocationGroupId | Edm.Int32 |
true
|
false
| Foreign key identifying the asset location |
LowerCabinetU | Edm.Int32 |
true
|
false
| The bottom U position in which the asset is mounted. |
MaterialId | Edm.Int32 |
true
|
false
| The key that identifies the material from which the asset was created. |
MaterialName | Edm.String |
true
|
false
| |
MaterialSubTypeId | Edm.Int32 |
true
|
false
| Each material type has its own sub-types, to properly identify the material and the asset created from the material. |
MaterialTypeId | Edm.Int32 | false |
false
| Entity representing the material type. Once an asset is created from a material, the asset type will be the material type from which was created. |
OperationalStatus | Nlyte.Model.OperationalStatusEnum | false |
false
| |
PoNumber | Edm.String |
true
|
false
| |
PowerStateId | Edm.Boolean |
true
|
false
| |
PrNumber | Edm.String |
true
|
false
| PR Number |
RecordStatus | Nlyte.Model.RecordStatusEnum | false |
false
| |
RfidTag | Edm.String |
true
|
false
| RFID Tag |
SapAssetNumber | Edm.String |
true
|
false
| |
SerialNumber | Edm.String |
true
|
false
| |
Tag | Edm.String |
true
|
false
| |
UDisplayLabel | Edm.Int32 |
true
|
false
| The U label to be displayed, representing the top or the bottom U position, depending on the admin parameter |
Property | Type | Nullable | Read-Only | Description |
---|
Property | Type | Nullable | Read-Only | Description |
---|
Property | Type | Nullable | Read-Only | Description |
---|
Key | Edm.String |
true
|
false
| |
Value | Edm.String |
true
|
false
| |
Property | Type | Nullable | Read-Only | Description |
---|
Property | Type | Nullable | Read-Only | Description |
---|
Property | Type | Nullable | Read-Only | Description |
---|
Property | Type | Nullable | Read-Only | Description |
---|
code | Edm.String |
true
|
false
| |
message | Edm.String |
true
|
false
| |
Property | Type | Nullable | Read-Only | Description |
---|
Property | Type | Nullable | Read-Only | Description |
---|
CanAutoAllocate | Edm.Boolean | false |
false
| |
CanCreate | Edm.Boolean | false |
false
| |
CanDecommission | Edm.Boolean | false |
false
| |
CanDuplicate | Edm.Boolean | false |
false
| |
Id | Edm.Int32 | false |
false
| |
LocationGroupId | Edm.Int32 | false |
false
| Foreign key identifying the project location |
LocationGroupName | Edm.String |
true
|
false
| The location name |
MaterialName | Edm.String |
true
|
false
| |
MaterialTypeId | Edm.Int32 | false |
false
| |
Name | Edm.String |
true
|
false
| |
Number | Edm.Int32 | false |
false
| |
OperationalStatusId | Edm.Int32 | false |
false
| Reflects the current state and/or planned future state of the asset assigned to a project. Together with the Record Status, they give the user the exact life-cycle status. |
RecordStatusId | Edm.Int32 | false |
false
| |
Property | Type | Nullable | Read-Only | Description |
---|
ActualEndDate | Edm.DateTimeOffset |
true
|
false
| |
ActualStartDate | Edm.DateTimeOffset |
true
|
false
| |
CreationDate | Edm.DateTimeOffset | false |
false
| |
ExpectedEndDate | Edm.DateTimeOffset |
true
|
false
| |
ExpectedStartDate | Edm.DateTimeOffset |
true
|
false
| |
Id | Edm.Int32 | false |
false
| |
Name | Edm.String |
true
|
false
| |
Number | Edm.Int32 | false |
false
| |
NumberOfAllocatedItems | Edm.Int32 | false |
false
| |
NumberOfCompletedItems | Edm.Int32 | false |
false
| |
StatusId | Edm.Int32 | false |
false
| |
TotalNumberOfItems | Edm.Int32 | false |
false
| |
TypeId | Edm.Int32 | false |
false
| Project type: allocation or forecast |
Property | Type | Nullable | Read-Only | Description |
---|
AllocatedCabinetAssetId | Edm.Int32 | false |
false
| |
AllocatedCabinetAssetNumber | Edm.Int32 | false |
false
| |
AllocatedCabinetName | Edm.String |
true
|
false
| |
AllocatedLocationGroupId | Edm.Int32 | false |
false
| Foreign key identifying the location |
AllocatedU | Edm.Int32 | false |
false
| |
Errors | Collection(Edm.String) |
true
|
false
| |
Id | Edm.Int32 | false |
false
| |
ItemStatusId | Edm.Int32 | false |
false
| |
PlannedName | Edm.String |
true
|
false
| |
PlannedNumber | Edm.Int32 | false |
false
| |
ProjectItemId | Edm.Int32 | false |
false
| |
StatusId | Edm.Int32 | false |
false
| |
Warnings | Collection(Edm.String) |
true
|
false
| |
Property | Type | Nullable | Read-Only | Description |
---|
ActionID | Edm.Int32 | false |
false
| |
ActionName | Nlyte.Model.ProjectItemActionEnum | false |
false
| Describes the purpose of the item |
AssetID | Edm.Int32 | false |
false
| |
ChassisMountedAssetCount | Edm.Int32 | false |
false
| |
HasRelatedAssets | Edm.Boolean | false |
false
| |
HostCount | Edm.Int32 | false |
false
| |
IsHost | Edm.Boolean | false |
false
| |
IsLeaf | Edm.Boolean | false |
false
| |
ItemName | Edm.String |
true
|
false
| |
ItemNumber | Edm.Int32 | false |
false
| |
LocationGroupID | Edm.Int32 |
true
|
false
| Foreign key identifying the project location |
ManufacturerID | Edm.Int32 |
true
|
false
| The manufacturer ID, used from the predefined list of manufacturers, defined for the asset associated to the current project |
MaterialID | Edm.Int32 | false |
false
| The key that identifies the material from which the asset/project item was created. |
MaterialName | Edm.String |
true
|
false
| |
MaterialNumber | Edm.Int32 | false |
false
| |
MaterialSubTypeID | Edm.Int32 | false |
false
| |
MaterialType | Edm.String |
true
|
false
| |
MaterialTypeID | Edm.Int32 | false |
false
| |
NumberOfCopies | Edm.Int32 | false |
false
| |
OperationalStatusID | Edm.Int32 |
true
|
false
| |
OperationID | Edm.Int32 | false |
false
| |
Order | Edm.Int32 | false |
false
| |
OwnedPeripheralCount | Edm.Int32 | false |
false
| |
OwnerAssetID | Edm.Int32 | false |
false
| |
ProjectItemID | Edm.Int32 | false |
false
| |
RecordStatusID | Edm.Int32 | false |
false
| |
Property | Type | Nullable | Read-Only | Description |
---|
Property | Type | Nullable | Read-Only | Description |
---|
ID | Edm.Int32 |
true
|
false
| |
Label | Edm.String |
true
|
false
| |
Result | Edm.Int32 | false |
false
| |
Value | Edm.String |
true
|
false
| |
Property | Type | Nullable | Read-Only | Description |
---|
Property | Type | Nullable | Read-Only | Description |
---|
NewId | Edm.Int32 | false |
false
| |
OldId | Edm.Int32 | false |
false
| |
Property | Type | Nullable | Read-Only | Description |
---|
Property | Type | Nullable | Read-Only | Description |
---|
Property | Type | Nullable | Read-Only | Description |
---|
TypeName | Edm.String |
true
|
false
| |
Property | Type | Nullable | Read-Only | Description |
---|
AssetID | Edm.Int32 | false |
false
| |
AssetName | Edm.String |
true
|
false
| |
AssetNumber | Edm.Int32 | false |
false
| |
ExternalDepth | Edm.Double | false |
false
| |
ExternalWidth | Edm.Double | false |
false
| |
HasRoomItem | Edm.Boolean | false |
false
| |
HeatingLimit | Edm.Double |
true
|
false
| |
HeatThreshold | Edm.Double |
true
|
false
| |
LocationGroupID | Edm.Int32 | false |
false
| |
LocationGroupName | Edm.String |
true
|
false
| The location name |
MaterialSubtype | Edm.String |
true
|
false
| |
MaterialSubtypeID | Edm.Int32 | false |
false
| |
MaterialType | Edm.String |
true
|
false
| |
MaterialTypeID | Edm.Int32 | false |
false
| |
OperationalStatus | Nlyte.Model.OperationalStatusEnum | false |
false
| |
RecordStatus | Nlyte.Model.RecordStatusEnum | false |
false
| |
WeightLimit | Edm.Double |
true
|
false
| |
WeightMaximum | Edm.Double |
true
|
false
| |
WeightThreshold | Edm.Double |
true
|
false
| |
Property | Type | Nullable | Read-Only | Description |
---|
Enumerations
Name | Value |
---|
DownFlow | 1 |
UpFlow | 2 |
Ambient | 3 |
DuctedDownFlow | 4 |
DuctedUpFlow | 5 |
Name | Value |
---|
FrontToBack | 1 |
BackToFront | 2 |
BottomToTop | 3 |
TopToBottom | 4 |
LeftToRight | 5 |
RightToLeft | 6 |
Ambient | 7 |
WaterCooled | 8 |
Name | Value |
---|
Area | 1 |
Pod | 2 |
Cage | 3 |
Container | 4 |
Module | 5 |
Zone | 6 |
Name | Value |
---|
Complete | 0 |
InProgress | 1 |
Error | 2 |
Canceled | 3 |
Name | Value |
---|
Creation | 0 |
Instantiation | 1 |
Copy | 2 |
Name | Value |
---|
New | 0 |
Active | 1 |
Inactive | 2 |
Name | Value |
---|
Asset | 1 |
FloorStandingAssets | 2 |
Name | Value |
---|
InQueue | 0 |
InProgress | 1 |
Completed | 2 |
Error | 3 |
Cancelled | 4 |
Deleted | 5 |
CancelRequested | 6 |
InQueueAllocated | 7 |
CancelRequestAllocated | 8 |
Name | Value |
---|
BusinessGroup | 0 |
SupportGroup | 1 |
Resource | 2 |
Name | Value |
---|
Active | 1 |
Cancelled | 2 |
Name | Value |
---|
Glass | 1 |
Acrylic | 2 |
Vented | 3 |
NonVented | 4 |
None | 5 |
Name | Value |
---|
KeyBarrel | 1 |
CodeKey | 2 |
SwipeCard | 3 |
None | 4 |
Name | Value |
---|
Power | 1 |
Network | 2 |
PowerAndNetwork | 3 |
Name | Value |
---|
SameCabinet | 1 |
Mounted | 2 |
NotMounted | 3 |
Name | Value |
---|
CeilingCenter | 1 |
UpperLeft | 2 |
UpperRight | 3 |
CenterLeft | 4 |
CenterRight | 5 |
LowerLeft | 6 |
LowerRight | 7 |
Floor | 8 |
BelowFloorCenter | 9 |
BelowFloorLeft | 10 |
BelowFloorRight | 11 |
CeilingLeft | 12 |
CeilingRight | 13 |
FloorLeft | 14 |
FloorRight | 15 |
NotApplicable | 16 |
Name | Value |
---|
Ascending | 1 |
Descending | 2 |
Name | Value |
---|
FirstSlotAvailable | 10 |
ScratchPad | 20 |
Name | Value |
---|
Valid | 0 |
AssetNotPresent | 10 |
PowerConsumptionExceded | 20 |
Name | Value |
---|
Network | 1 |
PowerSupplier | 2 |
PowerConsumer | 4 |
Name | Value |
---|
NotSet | 0 |
Server | 1 |
PDU | 2 |
Powerstrip | 3 |
Cabinet | 4 |
Network | 5 |
Peripheral | 6 |
KVMSwitch | 7 |
AirConditioning | 8 |
Receptacle | 9 |
Chassis | 53 |
Auxiliary | 54 |
StaticSwitch | 56 |
Ups | 57 |
Host | 99 |
ChassisMountedAsset | 777 |
Name | Value |
---|
TYPE_BASIC | 0 |
TYPE_ASSIGNEE | 1 |
TYPE_COMBOBOX_ITEM | 2 |
TYPE_DATE | 3 |
TYPE_INTEGRATION_COMBOBOX_ITEM | 4 |
TYPE_LOCATION | 5 |
TYPE_FIELD_PICKER | 6 |
Name | Value |
---|
None | 0 |
AnyValue | 1 |
CustomValue | 2 |
Name | Value |
---|
None | 0 |
Create | 1 |
Edit | 2 |
Name | Value |
---|
None | 0 |
Material | 1 |
Location | 2 |
BusinessGroup | 3 |
SupportGroup | 4 |
Software | 5 |
ChassisMountedAsset | 6 |
SQLView | 7 |
Name | Value |
---|
ServiceRequest | 1 |
TaskInstance | 2 |
Asset | 3 |
Material | 4 |
Host | 5 |
Software | 6 |
Name | Value |
---|
Solid | 0 |
Vertical1 | 11 |
Vertical2 | 12 |
Vertical3 | 13 |
Vertical4 | 14 |
Horizontal1 | 21 |
Horizontal2 | 22 |
Horizontal3 | 23 |
Horizontal4 | 24 |
Diagonal1 | 31 |
Diagonal2 | 32 |
Diagonal3 | 33 |
Diagonal4 | 34 |
Check1 | 41 |
Check2 | 42 |
Check3 | 43 |
Check4 | 44 |
DiagonalCheck1 | 51 |
DiagonalCheck2 | 52 |
DiagonalCheck3 | 53 |
DiagonalCheck4 | 54 |
Name | Value |
---|
Concrete | 1 |
Plaster | 2 |
Wood | 3 |
Name | Value |
---|
TextInput | 1 |
TextArea | 2 |
ComboBox | 3 |
CheckBox | 4 |
Label | 5 |
DatePicker | 6 |
UrlLink | 7 |
CascadingForm | 9 |
EquipmentPicker | 10 |
BusinessApplicationPicker | 11 |
FieldPicker | 12 |
RenameAssetControl | 13 |
RecycleAssetControl | 14 |
MoveAssetControl | 15 |
CreateAssetControl | 16 |
CompleteActivityControl | 17 |
EditAssetControl | 18 |
DecommissionAssetControl | 19 |
Name | Value |
---|
New | 0 |
Draft | 1 |
OnHold | 2 |
Archived | 3 |
Published | 4 |
Name | Value |
---|
BusinessGroup | 0 |
SupportGroup | 1 |
Name | Value |
---|
None | 0 |
Begin | 1 |
Cancel | 2 |
Move | 3 |
Complete | 4 |
Name | Value |
---|
Get | 0 |
Post | 1 |
PostWithKey | 2 |
Patch | 3 |
Delete | 4 |
Put | 5 |
Name | Value |
---|
Continue | 100 |
SwitchingProtocols | 101 |
OK | 200 |
Created | 201 |
Accepted | 202 |
NonAuthoritativeInformation | 203 |
NoContent | 204 |
ResetContent | 205 |
PartialContent | 206 |
MultipleChoices | 300 |
MovedPermanently | 301 |
Redirect | 302 |
SeeOther | 303 |
NotModified | 304 |
UseProxy | 305 |
Unused | 306 |
TemporaryRedirect | 307 |
BadRequest | 400 |
Unauthorized | 401 |
PaymentRequired | 402 |
Forbidden | 403 |
NotFound | 404 |
MethodNotAllowed | 405 |
NotAcceptable | 406 |
ProxyAuthenticationRequired | 407 |
RequestTimeout | 408 |
Conflict | 409 |
Gone | 410 |
LengthRequired | 411 |
PreconditionFailed | 412 |
RequestEntityTooLarge | 413 |
RequestUriTooLong | 414 |
UnsupportedMediaType | 415 |
RequestedRangeNotSatisfiable | 416 |
ExpectationFailed | 417 |
UpgradeRequired | 426 |
InternalServerError | 500 |
NotImplemented | 501 |
BadGateway | 502 |
ServiceUnavailable | 503 |
GatewayTimeout | 504 |
HttpVersionNotSupported | 505 |
Name | Value |
---|
Jpg | 1 |
Png | 2 |
Svg | 3 |
Tiff | 4 |
Bmp | 5 |
Gif | 6 |
Name | Value |
---|
CabinetWeightLimit | 1 |
ShelfWeightLimit | 2 |
Name | Value |
---|
LateDelivery | 1 |
IncorrectlyInstalled | 2 |
WrongEquipment | 3 |
ProjectOnHold | 4 |
CancellationReason | 5 |
Name | Value |
---|
ItemLayer | 1 |
ImageLayer | 2 |
Name | Value |
---|
ActiveDecommissioning | 1 |
ActiveMoving | 2 |
ActiveOperational | 3 |
ActiveRecycling | 4 |
PlannedDecommissioning | 5 |
PlannedMoving | 6 |
PlannedProcurement | 7 |
PlannedPreProcurement | 8 |
PlannedRecycling | 9 |
RecycledAvailable | 10 |
RecycledMoving | 11 |
Decommissioned | 13 |
CancelledCancelled | 14 |
Name | Value |
---|
World | 1 |
Region | 2 |
Country | 3 |
County | 4 |
City | 5 |
Building | 6 |
Floor | 7 |
Room | 8 |
Area | 9 |
Name | Value |
---|
AnyLocation | 0 |
SameRoom | 1 |
SameBuilding | 2 |
SameArea | 3 |
Name | Value |
---|
NotSet | 0 |
World | 1 |
Region | 2 |
Country | 3 |
County | 4 |
City | 5 |
Building | 6 |
Floor | 7 |
Room | 8 |
Area | 9 |
Name | Value |
---|
None | 0 |
Move | 1 |
Recycle | 2 |
Decommission | 4 |
All | 7 |
Name | Value |
---|
Elapsed | 0 |
ElapsedBefore | 5 |
ElapsedBeforeBaseControllerBegins | 10 |
SpentOnController | 12 |
SpentOnControllerWithoutOData | 15 |
SpentOnDbExtendedCommandInterception | 16 |
SpentOnDbCommandTreeInterception | 18 |
SpentOnDbCommandTreeSortInterception | 20 |
SpentOnDbCommandTreeSkipInterception | 21 |
SpentOnDbCommandTreeFunctionInterception | 30 |
SpentOnDbCommandTreeScanInterception | 40 |
SpentOnLocationGroupOrChildrenCommandInterceptor | 43 |
SpentOnGroupsOfResourceCommandInterceptor | 44 |
SpentOnJoinCommandInterceptor | 45 |
SpentOnContainsSearchCommandInterceptor | 47 |
SpentOnLicenseChecking | 50 |
SpentOnAuthorizationChecking | 60 |
SpentOnModelValidation | 70 |
SpentOnODataQueryPreparation | 80 |
SpentOnODataPostProcessing | 90 |
SpentCommittingOrRollingBackEfQuery | 100 |
ElapsedBeforeFinalSerialization | 110 |
Name | Value |
---|
Planned | 1 |
Active | 2 |
Inactive | 3 |
Cancelled | 4 |
Name | Value |
---|
Server | 1 |
PDU | 2 |
Powerstrip | 3 |
Cabinet | 4 |
Network | 5 |
Peripheral | 6 |
KVMSwitch | 7 |
AirConditioning | 8 |
Receptacle | 9 |
Chassis | 53 |
Auxiliary | 54 |
StaticSwitch | 56 |
UPS | 57 |
Host | 99 |
Name | Value |
---|
Metric | 1 |
Imperial | 2 |
Name | Value |
---|
Workflow | 1 |
Reporting | 2 |
API | 3 |
Realtime | 4 |
Discover | 5 |
DiscoverInventory | 6 |
Predict | 7 |
Dashboards | 8 |
ConnectionVisualization | 9 |
BulkAutoAllocation | 10 |
AssetSyncFramework | 11 |
Mobile | 12 |
Hygiene | 14 |
DataCenter | 15 |
NEO | 101 |
NSUM | 102 |
Command | 104 |
ML | 201 |
AssetExplorer | 301 |
Name | Value |
---|
Unmounted | 0 |
Internal | 1 |
OutsideRails | 2 |
OutsideRailsLeft | 3 |
OutsideRailsRight | 4 |
Name | Value |
---|
Front | 1 |
Back | 2 |
Right | 3 |
Left | 4 |
OnRight | 5 |
OnLeft | 6 |
Name | Value |
---|
Unmounted | 0 |
Front | 1 |
Back | 2 |
Name | Value |
---|
Rack19inch | 1 |
FullwidthShelf | 2 |
FloorStanding | 3 |
Name | Value |
---|
None | 0 |
NetworkCard | 1 |
Patch | 2 |
Cable | 3 |
Name | Value |
---|
FacePlate | 1 |
FloorBox | 2 |
Name | Value |
---|
MPO008 | 1 |
MPO012 | 2 |
MPO016 | 3 |
MPO024 | 4 |
MPO032 | 5 |
MPO036 | 6 |
MPO048 | 7 |
MPO072 | 8 |
MPO144 | 9 |
QSFPCopper | 10 |
QSFPFiber | 11 |
Name | Value |
---|
Copper | 1 |
Fibre | 2 |
Unknown | 3 |
Name | Value |
---|
Copper | 1 |
Fiber | 2 |
Undefined | 3 |
Name | Value |
---|
Standard | 7 |
Module | 8 |
PatchPanel | 9 |
Name | Value |
---|
Standard | 7 |
Module | 8 |
Panel | 9 |
NetworkCard | 10 |
Name | Value |
---|
None | 0 |
Asset | 1 |
BusinessGroup | 2 |
InternalEquipmentItem | 3 |
InternalEquipmentItemUtilization | 4 |
SupportGroup | 5 |
IPAddressNetworkDependency | 6 |
AssetAssociationMap | 7 |
Host | 8 |
NetworkPort | 9 |
PeripheralAssetLink | 10 |
ServiceRequest | 11 |
TaskInstance | 12 |
LocationGroup | 13 |
Name | Value |
---|
PreProcurement | 1 |
Procurement | 2 |
Operational | 3 |
Recycling | 4 |
Decommissioning | 5 |
Available | 6 |
Moving | 7 |
Decommissioned | 8 |
Cancelled | 9 |
Name | Value |
---|
Active | 1 |
Cancelled | 2 |
Name | Value |
---|
NotSet | 0 |
Allow | 4 |
Deny | -1 |
Name | Value |
---|
_2PplusE | 1 |
_3PplusE | 2 |
_3PplusNplusE | 3 |
Name | Value |
---|
Temperature | 1 |
Humidity | 2 |
LeakDetect | 3 |
Name | Value |
---|
Ok | 0 |
MandatoryValueRequired | 1 |
UniqueValueWarning | 2 |
UniqueValueRequired | 3 |
Name | Value |
---|
Off | 1 |
Warning | 2 |
Error | 3 |
Name | Value |
---|
Modbus | 1 |
SNMP | 2 |
JSON | 3 |
XML | 4 |
JCI | 5 |
ALC | 6 |
Tridium | 7 |
Modius | 8 |
OPC | 9 |
CSV | 10 |
BACnetIP | 11 |
ModbusRTU | 12 |
PacketPower | 13 |
Name | Value |
---|
None | 0 |
Patch | 1 |
Cable | 2 |
HybridPatch | 3 |
HybridNetworkCard | 4 |
Name | Value |
---|
Free | 1 |
Patched | 2 |
Connected | 3 |
Broken | 4 |
Reserved | 5 |
PatchedReserved | 6 |
Planned | 7 |
Mixed | -1 |
Name | Value |
---|
VRLA | 1 |
Wet | 2 |
NiCd | 3 |
Li | 4 |
Name | Value |
---|
Connect | 0 |
Disconnect | 1 |
DisconnectAll | 2 |
ModifyCapacity | 3 |
ModifyPowerState | 4 |
UpdateDetails | 5 |
Name | Value |
---|
None | 0 |
OnePhase | 1 |
TwoPhase | 2 |
ThreePhase | 3 |
DirectCurrent | 10 |
Name | Value |
---|
CabinetUsage | 1 |
Project | 2 |
ProjectAction | 3 |
FunctionalUse | 5 |
OperationalUse | 6 |
ServerHostCompliance | 7 |
BusinessApplicationLifecycleStatus | 8 |
BusinessApplicationStrategy | 9 |
BusinessCriticality | 10 |
DataConfidentiality | 11 |
DataRecovery | 12 |
StorageUsage | 13 |
SoftwareType | 14 |
NetworkConnector | 20 |
NetworkCableType | 21 |
NetworkSpeed | 22 |
NetworkCardPortName | 23 |
IPUsage | 24 |
NetworkUsage | 25 |
NetworkPortDataType | 26 |
PhysicalPartitionType | 30 |
LogicalPartitionType | 40 |
Name | Value |
---|
Urgent | 1 |
High | 2 |
Medium | 3 |
Low | 4 |
Name | Value |
---|
Urgent | 1 |
PastDuration | 2 |
Viewed | 3 |
None | 4 |
Name | Value |
---|
WindowsServer | 1 |
UnixServer | 2 |
IbmServer | 3 |
Name | Value |
---|
New | 1 |
Draft | 2 |
OnHold | 3 |
Archived | 4 |
Validated | 5 |
Published | 6 |
Name | Value |
---|
New | 1 |
Upgrade | 2 |
Move | 3 |
Decommission | 4 |
Recycle | 5 |
Name | Value |
---|
Allocate | 1 |
CreateAndAllocate | 2 |
DuplicateAndAllocate | 3 |
Decommission | 4 |
Name | Value |
---|
Planned | 1 |
Completed | 3 |
Cancelled | 4 |
NonViable | 8 |
Broken | 9 |
Allocated | 10 |
Deleted | 11 |
Forecasted | 12 |
Name | Value |
---|
AutoAllocate | 1 |
Forecast | 2 |
Commit | 3 |
Cancel | 4 |
Complete | 5 |
None | -1 |
Name | Value |
---|
Planned | 1 |
Committed | 2 |
Completed | 3 |
CompletedCancelled | 4 |
InProgress | 5 |
Forecast | 6 |
Viable | 7 |
NonViable | 8 |
Broken | 9 |
Allocated | 10 |
Forecasted | 12 |
Name | Value |
---|
AutoAllocation | 1 |
Forecast | 2 |
All | 3 |
Name | Value |
---|
TaskOpened | 1 |
TaskClosed | 2 |
TaskAssigned | 3 |
TaskOpenReminder | 4 |
ServiceMaxLoopExceeded | 5 |
ServiceRequestFaulted | 6 |
ServiceRequestCancelled | 7 |
ServiceRequestCompleted | 8 |
ServiceRequestStarted | 9 |
TaskInstanceReassigned | 10 |
TaskSkipped | 11 |
TaskCancelled | 12 |
Name | Value |
---|
Planned | 1 |
Active | 2 |
Recycled | 3 |
Decommissioned | 4 |
Cancelled | 5 |
Name | Value |
---|
Move | 1 |
Recycle | 2 |
Decommission | 4 |
AutoAllocateDuplicate | 7 |
Name | Value |
---|
CableTray | 1 |
PopulatedCableTray | 2 |
NarrowCableBasket | 3 |
PopulatedNarrowCableBasket | 4 |
WideCableBasket | 5 |
PopulatedWideCableBasket | 6 |
VentedTile | 20 |
TilewithCentralRectangularHole | 21 |
TilewithCentralRectangularHoleonOneSide | 22 |
TilewithCentralRoundHole | 23 |
TilewithCentralSquareHole | 24 |
TilewithCentralSquareHoleonOneSide | 25 |
FireSensor | 40 |
FireSuppressionSystem | 41 |
HeatSensor | 42 |
SmokeSensor | 43 |
WaterSensor | 44 |
DoubleLeafDoor | 60 |
DoubleLeafDoorWithHalfLeaf | 61 |
DoubleLeafSwingDoorWithHalfLeaf | 62 |
DoubleSwingDoor | 63 |
RevolvingDoor | 64 |
SingleLeafDoor | 65 |
SingleLeafSwingDoor | 66 |
SlidingDoor | 67 |
SlidingCentreDoor | 68 |
RoundColumn | 90 |
SquareColumn | 91 |
Window | 92 |
Name | Value |
---|
Unassigned | 0 |
BelowFloor | 1 |
Floor | 2 |
Bottom | 3 |
Middle | 4 |
Top | 5 |
Ceiling | 6 |
Name | Value |
---|
Assignee | 0 |
Performer | 1 |
Duration | 2 |
Status | 3 |
Location | 4 |
Name | Value |
---|
Assignee | 0 |
Performer | 1 |
Duration | 2 |
Status | 3 |
Name | Value |
---|
EqualTo | 0 |
GreaterThan | 1 |
LessThan | 2 |
GreaterThanOrEqualTo | 3 |
LessThanOrEqualTo | 4 |
Contains | 5 |
NotEqualTo | 6 |
In | 7 |
Name | Value |
---|
NoAction | 0 |
Create | 1 |
Update | 2 |
Delete | 3 |
Name | Value |
---|
Ok | 0 |
ConcurrentlyModified | 1 |
Name | Value |
---|
SubmitRequested | 1 |
Draft | 2 |
Open | 3 |
Closed | 4 |
Hold | 6 |
Failed | 7 |
Cancelled | 8 |
Name | Value |
---|
Planned | 1 |
Active | 2 |
Inactive | 3 |
Cancelled | 4 |
Name | Value |
---|
UtilityCompany | 1 |
Battery | 2 |
Name | Value |
---|
BranchContainer | 101 |
Branch | 102 |
LoopContainer | 103 |
ParallelContainer | 104 |
SequenceContainer | 105 |
Name | Value |
---|
Inactive | 1 |
Finished | 2 |
Active | 3 |
Name | Value |
---|
Failed | 1 |
Skipped | 3 |
Open | 4 |
Active | 5 |
Pending | 7 |
Cancelled | 8 |
Completed | 9 |
Running | 10 |
Name | Value |
---|
UserTask | 1 |
CreateAsset | 2 |
MoveAsset | 3 |
RenameAsset | 4 |
RecycleAsset | 5 |
CompletePlannedAction | 7 |
Integration | 9 |
SLAStart | 10 |
EditAsset | 11 |
DecommissionAsset | 12 |
Name | Value |
---|
Closed | 1 |
Vented | 2 |
Assisted | 3 |
Name | Value |
---|
ConnectedPorts | 1 |
Power | 2 |
PlannedPorts | 4 |
Name | Value |
---|
Fahrenheit | 11 |
Celcius | 12 |
PercentageRH | 21 |
L_NL | 31 |
Name | Value |
---|
V48 | 48 |
V190 | 190 |
V200 | 200 |
V208 | 208 |
V220 | 220 |
V230 | 230 |
V240 | 240 |
V280 | 280 |
V380 | 380 |
V400 | 400 |
V415 | 415 |
V440 | 440 |
V480 | 480 |
V600 | 600 |