Nlyte RESTful API Reference - v 14.0.300.44518

Entities   Controllers   Complex Types   Enumerations  

Entities

AirConditioning

AirConditioningMaterial

AncestralInfo

Anchor

Area

AreaBusinessGroupMap

AreaStatus

AreaSupportGroupMap

AreaUsage

Asset

AssetAndHost

AssetAndHostIPAddressMap

AssetAssociationMap

AssetAssociationMapNote

AssetDisplayLocation

AssetFile

AssetIPAddressMap

AssetMapping

AssetMounting

AssetNote

AssetRealTimeData

AssetRealTimePhaseData

AssetSummaryDC

AssetTemplate

AssetTemplateInstance

AssetTemplateJob

AssetTemplateJobItem

AssetUploaderJob

AssetUploaderJobItem

Assignee

AuditLogInfo

Auxiliary

AuxiliaryMaterial

BladeServerMaterial

BoardPDUMaterial

Breaker

BreakerPanel

BusBarPDUMaterial

BusinessApplication

BusinessApplicationBusinessGroupMap

BusinessApplicationLifecycleStatus

BusinessApplicationPickerControl

BusinessApplicationPickerControlValue

BusinessApplicationServerHostMap

BusinessApplicationStrategy

BusinessApplicationSupportGroupMap

BusinessCriticality

BusinessGroup

BusinessGroupAssetMap

BusinessGroupNote

BusinessGroupResourceMap

Cabinet

CabinetAssetMounting

CabinetMarker

CabinetMaterial

CabinetResourceMap

CabinetU

CabinetUsage

Cable

CableConnection

CardConnection

CardNetworkMaterial

CascadingForm

CascadingFormControl

CascadingFormControlValue

CatalogType

CeilingMaterial

Chassis

ChassisAssetMounting

ChassisMaterial

ChassisMaterialSlot

ChassisMountedAssetMap

ChassisSlots

CheckBoxControl

CheckBoxControlValue

CloudProvider

ComboBoxControl

ComboBoxControlValue

CompleteActivityControl

CompleteActivityControlValue

ConsumerDistributorMaterialType

ConsumerMaterial

ConsumerMaterialType

ControlAsset

CreateAssetControl

CreateAssetControlValue

CrossSectionalArea

Culture

CustomField

CustomFieldLookupValue

CustomFieldType

DataConfidentiality

DataRecovery

DatePickerControl

DatePickerControlValue

DecommissionAssetControl

DecommissionAssetControlValue

DisplayProperties

DistributorMaterial

DistributorMaterialType

EditAssetControl

EditAssetControlValue

EquipmentPickerAsset

EquipmentPickerControl

EquipmentPickerControlValue

ExclusionDate

ExtendedRecordListItem

FieldPickerControl

FieldPickerControlValue

File

Floor

FloorLayer

FlywheelGeneratorAuxiliaryMaterial

Form

FormBuilderMetaDataList

FormControl

FormControlReportingTag

FormInstanceControlValue

FunctionalUse

Graph

Grid

GridLabel

Group

HostFile

HostMapping

HostNote

ImportedProcessResult

InputConnector

InputConnectorMaterial

InputConnectorType

IntegrationActivityParameter

IntegrationActivityParameterValueItem

IntegrationSystem

IntegrationSystemActivity

IntegrationSystemActivityType

InternalEquipmentCategory

InternalEquipmentCategorySize

InternalEquipmentItem

InternalEquipmentItemNote

InternalEquipmentItemUtilisation

InternalEquipmentItemUtilizationNote

IPAddress

IPAddressNetworkDependencyNote

IPUsage

Issue

KeyboardPeripheralMaterial

KVMSwitch

KVMSwitchCabinetMap

KVMSwitchMaterial

KVMSwitchPortConsumerLink

LabelControl

LabelControlValue

Layer

LayerImage

License

ListItem

ListType

LocationGroup

LocationGroupNote

LocationPurpose

LogicalPartitionType

Maintenance

Manufacturer

Marker

MasterBreaker

Material

MaterialAndSoftware

MaterialCategory

MaterialFile

MaterialImage

MaterialSubtype

MaterialType

Measurement

MeasurementSystem

ModuleNetworkMaterial

MonitorPeripheralMaterial

MountingType

MousePeripheralMaterial

MoveAssetControl

MoveAssetControlValue

NameConvention

NameConventionSet

NavigatorAsset

Network

NetworkCableType

NetworkCardPortName

NetworkConnectorType

NetworkGraph

NetworkMaterial

NetworkMaterialPort

NetworkMaterialPortGroup

NetworkMaterialPortGroupMap

NetworkPort

NetworkPortAssetIPAddressMap

NetworkPortConnection

NetworkPortDataType

NetworkPortGroup

NetworkPortGroupAssetIPAddressMap

NetworkPortGroupServerHostIPAddressMap

NetworkPortGroupType

NetworkPortNote

NetworkPortServerHostIPAddressMap

NetworkPortServiceProvider

NetworkSpeed

NetworkUsage

Note

OperationalUse

OutputConnector

OutputConnectorMaterial

OutputConnectorMaterialWire

OutputConnectorRealTimeData

OutputConnectorRealTimePhaseData

OutputConnectorType

OutputConnectorWire

Overlay

PagedAutoAllocateSearchResult

PanelNetworkMaterial

PDU

PDUMaterial

Peripheral

PeripheralAssetLink

PeripheralAssetLinkNote

PeripheralMaterial

Permission

PhysicalPartition

PhysicalPartitionType

PollType

Polygon

PolygonPoint

PowerMaterial

PowerStrip

PowerStripMaterial

Process

ProcessForm

ProcessFormControl

Project

ProjectAction

ProjectDependency

ProjectItem

ProjectItemAllocateCriteria

ProjectItemHistory

ProjectPurpose

Provider

RealTimeDataProvider

RealTimeInfo

RealTimeValue

Receptacle

ReceptacleMaterial

RecordListItem

RecordType

RecycleAssetControl

RecycleAssetControlValue

RenameAssetControl

RenameAssetControlValue

ReplaceFormResult

ReportingTag

Resource

Room

RoomDrawingInfo

RoomItem

RoomItemAsset

RoomItemSimple

RoomLayer

RPPPDUMaterial

Scheme

SchemeColour

Server

ServerHost

ServerHostBusinessGroupMap

ServerHostCompliance

ServerHostIPAddressMap

ServerHostSoftwareMap

ServerHostSupportGroupMap

ServerMaterial

ServiceRequest

ServiceRequestFile

ServiceRequestNote

Shelf

Software

SoftwareFile

SoftwareManufacturer

SoftwareType

SqlView

SqlViewValue

StandardGeneratorAuxiliaryMaterial

StandardNetworkMaterial

StandardPDUMaterial

StandardServerMaterial

StaticSwitch

StaticSwitchMaterial

StoragePeripheralMaterial

StorageUsage

Subnet

SubnetLocationGroupMap

SubStatus

Supplier

SupplierMaterial

SupplierMaterialWire

SupplierWire

SupportGroup

SupportGroupAssetMap

SupportGroupNote

SupportGroupResourceMap

Task

TaskContainer

TaskForm

TaskFormControl

TaskInstance

TaskInstanceFile

TaskInstanceIntegrationAttributes

TaskInstanceNote

TaskIntegrationAttributes

TextAreaControl

TextAreaControlValue

TextInputControl

TextInputControlValue

TraceAsset

TraceLink

TraceSummary

TransformerAuxiliaryMaterial

UMounting

UnplacedRoom

UPS

UPSMaterial

UrlLinkControl

UrlLinkControlValue

UserAccount

UserAccountPermission

UserEffectivePermission

UserGroup

UserGroupPermission

Wall

Warning

Warranty

Wire

WorkingHours

Zone


Controllers

AirConditioningMaterials

AirConditionings

AssetRealTimeData

AssetRealTimePhaseData

Assets

AssetsAndHosts

AssetTemplateInstances

AssetTemplateJobs

AssetTemplates

AssetUploaderJobs

Assignees

Auxiliaries

AuxiliaryMaterials

BladeServerMaterials

BoardPDUMaterials

BreakerPanels

Breakers

BusBarPDUMaterials

BusinessApplications

BusinessGroups

CabinetMarkers

CabinetMaterials

Cabinets

CardNetworkMaterials

CatalogTypes

CeilingMaterials

Chassis

ChassisMaterials

CloudProviders

Connections

CrossSectionalAreas

Cultures

CustomFieldTypes

ExclusionDates

Floors

FlywheelGeneratorAuxiliaryMaterials

FormBuilderMetaDataLists

Forms

Graphs

Groups

IntegrationSystems

InternalEquipmentCategories

InternalEquipmentItems

InternalEquipmentItemUtilisations

IPAddresses

KeyboardPeripheralMaterials

KVMSwitches

KVMSwitchMaterials

LayerImages

License

ListTypes

LocationGroups

LogicalPartitionTypes

Manufacturers

MasterBreakers

MaterialCategories

MaterialImages

Materials

MaterialsAndSoftware

MaterialSubtypes

MaterialTypes

ModuleNetworkMaterials

MonitorPeripheralMaterials

MousePeripheralMaterials

NavigatorAssets

NetworkCableTypes

NetworkCardPortNames

NetworkGraphs

NetworkMaterials

NetworkPortGroups

NetworkPortGroupTypes

NetworkPorts

Networks

OutputConnectorRealTimeData

OutputConnectorRealTimePhaseData

Overlays

PanelNetworkMaterials

PDUMaterials

PDUs

PeripheralMaterials

Peripherals

Permissions

PollTypes

PowerStripMaterials

PowerStrips

Processes

ProjectDependencies

ProjectItemAllocateCriterias

ProjectItems

Projects

Providers

RealTimeDataProviders

RealTimeInfo

ReceptacleMaterials

Receptacles

RecordTypes

ReportingTags

Resources

Rooms

RPPPDUMaterials

SchemeColours

Search

ServerHosts

ServerMaterials

Servers

ServiceRequests

Shelfs

SoftwareManufacturers

Softwares

SoftwareTypes

StandardGeneratorAuxiliaryMaterials

StandardNetworkMaterials

StandardPDUMaterials

StandardServerMaterials

StaticSwitches

StaticSwitchMaterials

StoragePeripheralMaterials

SubnetLocationGroupMaps

Subnets

SupplierMaterials

SupplierMaterialWires

SupportGroups

TaskInstances

TransformerAuxiliaryMaterials

UPSMaterials

UPSs

UserAccountPermissions

UserAccounts

UserEffectivePermissions

UserGroupPermissions

Utilities

WorkingHours


Complex Types

AllocateCriteria

AssetActivityResponse

AssetAllocationCriteria

AssetMap

AssetNetworkPortLinkage

AssetOverlay

AssetProperties

AssetSummary

AutoAllocateSearchResult

AutoAllocationMessage

ByteArrayContent

ByteRangeStreamContent

ChangeSetResponseItem

ChassisMountableAsset

ChassisWithFreeSlots

ComboBoxControlItem

ComboBoxControlNestedItem

ControlValueSummary

Distributor

ExpectedODataError

ExpectedODataErrorBase

ExpectedODataErrorDetails

FormUrlEncodedContent

HttpContent

HttpMessageContent

HttpMethod

HttpRequestMessage

HttpResponseMessage

KeyValue

KeyValuePair_2OfString_IEnumerable_1OfString

KeyValuePair_2OfString_String

LinkedRecordsSummary

MountedAssetSummary

MultipartContent

MultipartFormDataContent

NameValue

NetworkResult

NetworkResults

ObjectContent

ObjectContent_1OfT

ODataBatchContent

ODataBatchResponseItem

ODataError

ODataErrorDetail

OperationResponseItem

ProjectAssetSearchResult

ProjectExecutionHistorySummary

ProjectGanttItem

ProjectItemHistorySummary

ProjectItemSummary

PushStreamContent

ReportColour

ReportColourScheme

Result

ResultIds

StreamContent

StringContent

TemplateAssetSummary

UnplacedAsset

Uri

Version


Enumeration Types

AirConditioningFlowDirectionEnum

AirflowTypeEnum

AreaType

AssetTemplateJobStatus

AssetTemplateJobType

AssetTemplateStatus

AssetTemplateType

AssetTypeEnum

AssetUploaderJobStatus

AssigneeType

BusinessApplicationRecordStatus

CabinetDoorTypeEnum

CabinetLockTypeEnum

CabinetMapResourceType

CabinetMountingStatus

CabinetPositionEnum

CabinetUOrderEnum

CabinetUStateEnum

ChassisMountingStrategy

ChassisMountingValidationResult

ConnectionTypeEnum

CreateAssetMaterialType

CustomRuleOperandType

DependencyType

EditAssetTypeEnum

FieldPickerEntityType

FileEntityType

FillType

FloorPlannerMaterial

FormControlType

FormStatus

GroupType

HostMoveOperationsEnum

HttpAction

HttpStatusCode

ImageFileType

IntegrationTagCategory

IntegrationTagType

IssueType

IssueTypeWf

LayerType

LifeCycleStatusEnum

LocationGroupTypeEnum

LocationTarget

LocationType

LocationUsageFlags

LoggerEvents

MaterialImageTypeEnum

MaterialRecordStatus

MaterialTypeEnum

MeasurementSystem

Module

MountingPlacement

MountingRotation

MountingSide

MountingTypeEnum

NetworkLinkerType

NetworkPanelTypeEnum

NetworkPortGroupTypeEnum

NetworkPortType

NetworkPortTypeEnum

NetworkSubTypeEnum

NetworkType

NoteEntityType

OperationalStatusEnum

OrganisationGroupRecordStatus

PermissionState

PinConfigurationEnum

PointTypeEnum

PolicyMandatorySetting

PolicyResult

PolicyUniqueSetting

PollTypeEnum

PortLocation

PortState

PositionOnGrid

PowerBatteryTypeEnum

PowerConnectionRequestType

PowerStateEnum

PowerTypeEnum

PredefinedListType

Priority

PriorityFocus

ProcessCategory

ProcessStatus

ProcessType

ProjectItemActionEnum

ProjectItemStatusEnum

ProjectJobAction

ProjectStatusEnum

ProjectTypeEnum

Reason

RecordStatusEnum

RelocateType

RoomItemCategory

RoomOrientationEnum

RuleOperandCustomType

RuleOperandServiceRequestType

RuleOperandTaskType

RuleOperatorType

SaveActionEnum

SaveOperationResult

ServiceRequestStatus

SoftwareRecordStatus

SupplierTypeEnum

TaskContainerType

TaskInstanceActivityMode

TaskInstanceStatus

TaskType

TopPanelEnum

TraceFilterEnum

UnitsEnum

VoltsL2LEnum

ZoneType

AirConditioning Entity : Asset - Asset created from a material of type air conditioning, entity inheriting the Nlyte.Model.Asset entity

Verb(s)Required Permission(s)LinkDescription
GetWS-ReadAirConditioningintegration/api/odata/AirConditionings, integration/api/odata/AirConditionings({key})
PatchWS-ModifyAirConditioningintegration/api/odata/AirConditionings({key})
DeleteWS-ModifyAirConditioningintegration/api/odata/AirConditionings({key})
PostWithKeyWS-ModifyAirConditioningintegration/api/odata/AirConditionings({key})
PostWS-AddAirConditioningintegration/api/odata/AirConditionings

Key(s)
AssetID

AirConditioning Structural Properties

PropertyTypeNullableMandatoryRead-OnlyString lengthMin ValueMax ValuePrecisionMax Dec PlacesIs Only DateDescription
AuditDateEdm.DateTimeOffsettruefalse false N/AN/AN/AN/AN/A
AuditStatusCorrectEdm.Booleantruefalse false N/AN/AN/AN/AN/A
LastAuditorAccountIDEdm.Int32truefalse false N/AN/AN/AN/AN/A
ManufactureDateEdm.DateTimeOffsettruefalse false N/AN/AN/AN/AN/AIsOnlyDate
ServiceDateEdm.DateTimeOffsettruefalse false N/AN/AN/AN/AN/AIsOnlyDate
TotalPlugsEdm.Int32falsefalse true N/AN/AN/AN/AN/A

AirConditioning Navigational Properties

PropertyType
AirConditioningMaterialNlyte.Model.AirConditioningMaterial
InputConnectorsCollection(Nlyte.Model.InputConnector)



AirConditioningMaterial Entity : Material - Material type inheriting properties from the base type

Verb(s)Required Permission(s)LinkDescription
GetWS-ReadAirConditioningMaterialintegration/api/odata/AirConditioningMaterials, integration/api/odata/AirConditioningMaterials({key})
PostWS-AddAirConditioningMaterialintegration/api/odata/AirConditioningMaterials
PostWithKeyWS-ModifyAirConditioningMaterialintegration/api/odata/AirConditioningMaterials({key})
PatchWS-ModifyAirConditioningMaterialintegration/api/odata/AirConditioningMaterials({key})
DeleteWS-ModifyAirConditioningMaterialintegration/api/odata/AirConditioningMaterials({key})

Key(s)
MaterialID

AirConditioningMaterial Structural Properties

PropertyTypeNullableMandatoryRead-OnlyString lengthMin ValueMax ValuePrecisionMax Dec PlacesIs Only DateDescription
AirConditioningFlowDirectionIDNlyte.Model.AirConditioningFlowDirectionEnumfalsetrue false N/AN/AN/AN/AN/A
CalculatedMpafPowerConsumptionEdm.Decimaltruefalse true N/AN/AN/AN/AN/ARead-only property, value provided by the service based on the PublishedPowerConsumption and the MpafOverride
ConsumerPowerFactorEdm.Decimalfalsefalse true N/AN/AN/AN/AN/ARead-only property representing the percentage of power drawn by a PDD material that is available to its asset consumers
MaterialCategoryIDEdm.Int32truefalse false N/AN/AN/AN/AN/A
MpafOverrideEdm.Decimaltruefalse false N/A0.00199963Value inserted by the user, while the material is in Planned status
NominalCoolingEdm.Doublefalsefalse false N/A0999999999999.999153
PowerTypeIDNlyte.Model.PowerTypeEnumfalsetrue false N/AN/AN/AN/AN/APower type: phased or direct current
PublishedPowerConsumptionEdm.Decimalfalsefalse false N/A0.00199963Value inserted by the user, while the material is in Planned status
RequiredPlugsEdm.Int32falsefalse false N/AN/AN/AN/AN/AValue inserted by the user, while the material is in Planned status
RequiresDiversePowerEdm.Booleanfalsefalse false N/AN/AN/AN/AN/AValue available to be updated by the user only if RequiredPlugs TotalPlugs
TotalPlugsEdm.Int32falsetrue false N/AN/AN/AN/AN/AValue inserted by the user, while the material is in Planned status
UHeightEdm.Int64falsefalse true N/AN/AN/AN/AN/A
WorkableFootPrintFrontEdm.Doublefalsefalse false N/A0999999999999.9999164
WorkableFootPrintHeightEdm.Doublefalsefalse false N/A0999999999999.9999164
WorkableFootPrintRearEdm.Doublefalsefalse false N/A0999999999999.9999164

AirConditioningMaterial Navigational Properties

PropertyType
InputConnectorMaterialsCollection(Nlyte.Model.InputConnectorMaterial)



AncestralInfo Entity - Entity providing details about the location as a flat list

Verb(s)Required Permission(s)LinkDescription

Key(s)
ChildLocationGroupID

AncestralInfo Structural Properties

PropertyTypeNullableMandatoryRead-OnlyString lengthMin ValueMax ValuePrecisionMax Dec PlacesIs Only DateDescription
BuildingEdm.Stringtruefalse true 150N/AN/AN/AN/A
ChildLocationGroupIDEdm.Int32false false
CityEdm.Stringtruefalse true 150N/AN/AN/AN/A
CountryEdm.Stringtruefalse true 150N/AN/AN/AN/A
CountyEdm.Stringtruefalse true 150N/AN/AN/AN/A
FloorEdm.Stringtruefalse true 150N/AN/AN/AN/A
RegionEdm.Stringtruefalse true 150N/AN/AN/AN/A
RoomEdm.Stringtruefalse true 150N/AN/AN/AN/A

AncestralInfo Navigational Properties

No navigational properties


Anchor Entity

Verb(s)Required Permission(s)LinkDescription
GetWS-ReadRoomPlan
PatchWS-ModifyRoomPlan
PutWS-ModifyRoomPlan
DeleteWS-ModifyRoomPlan
PostWS-ModifyRoomPlan

Key(s)
ID

Anchor Structural Properties

PropertyTypeNullableMandatoryRead-OnlyString lengthMin ValueMax ValuePrecisionMax Dec PlacesIs Only DateDescription
IDEdm.Int32falsefalse false N/AN/AN/AN/AN/A
SaveActionNlyte.Model.SaveActionEnumfalsefalse false N/AN/AN/AN/AN/A
XEdm.Decimalfalsefalse false N/A09999999.999103
YEdm.Decimalfalsefalse false N/A09999999.999103

Anchor Navigational Properties

No navigational properties


Area Entity : Marker

Verb(s)Required Permission(s)LinkDescription
GetWS-ReadRoomPlan
PatchWS-ModifyRoomPlan
PutWS-ModifyRoomPlan
DeleteWS-ModifyRoomPlan
PostWS-ModifyRoomPlan

Key(s)
ID

Area Structural Properties

PropertyTypeNullableMandatoryRead-OnlyString lengthMin ValueMax ValuePrecisionMax Dec PlacesIs Only DateDescription
AreaStatusIDEdm.Int32truefalse false N/AN/AN/AN/AN/A
AreaTypeIdNlyte.Model.AreaTypefalsetrue false N/AN/AN/AN/AN/A
AreaUsageIDEdm.Int32truefalse false N/AN/AN/AN/AN/A
CabinetForecastNumberEdm.Int32truefalse false N/AN/AN/AN/AN/A
ConsumesFloorSpaceEdm.Booleanfalsefalse false N/AN/AN/AN/AN/A
CoolingLimitEdm.Decimaltruefalse false N/A09999999.999103
CoolingMaximumEdm.Decimaltruefalse false N/A09999999.999103
CoolingThresholdEdm.Decimaltruefalse false N/A09999999.999103
EndDateEdm.DateTimeOffsettruefalse false N/AN/AN/AN/AN/AIsOnlyDate
HeatLimitEdm.Decimaltruefalse false N/A09999999.999103
HeatMaximumEdm.Decimaltruefalse false N/A09999999.999103
HeatThresholdEdm.Decimaltruefalse false N/A09999999.999103
LocationGroupIDEdm.Int32truefalse true N/AN/AN/AN/AN/AForeign key identifying the location
NameEdm.Stringtruetrue false 150N/AN/AN/AN/AArea Name. This must be unique for a Room.
NominalPowerEdm.Decimaltruefalse false N/A09999999.999103
RoomIdEdm.Int32truefalse true N/AN/AN/AN/AN/A
RoomLocationGroupIdEdm.Int32falsefalse true N/AN/AN/AN/AN/A
StartDateEdm.DateTimeOffsettruefalse false N/AN/AN/AN/AN/AIsOnlyDate
UsedAreaEdm.Decimalfalsefalse true N/AN/AN/AN/AN/A
WeightLimitEdm.Decimaltruefalse false N/A09999999.9999114
WeightMaximumEdm.Decimaltruefalse false N/A09999999.9999114
WeightThresholdEdm.Decimaltruefalse false N/A09999999.9999114

Area Navigational Properties

PropertyType
AreaBusinessGroupsCollection(Nlyte.Model.AreaBusinessGroupMap)
AreaStatusNlyte.Model.AreaStatus
AreaSupportGroupsCollection(Nlyte.Model.AreaSupportGroupMap)
AreaUsageNlyte.Model.AreaUsage
LocationGroupNlyte.Model.LocationGroup
RoomNlyte.Model.Room
RoomLocationGroupNlyte.Model.LocationGroup



AreaBusinessGroupMap Entity

Verb(s)Required Permission(s)LinkDescription
GetWS-ReadRoomPlan
PatchWS-ModifyRoomPlan
PutWS-ModifyRoomPlan
DeleteWS-ModifyRoomPlan
PostWS-ModifyRoomPlan

Key(s)
ID

AreaBusinessGroupMap Structural Properties

PropertyTypeNullableMandatoryRead-OnlyString lengthMin ValueMax ValuePrecisionMax Dec PlacesIs Only DateDescription
AreaMarkerIDEdm.Int32truefalse true N/AN/AN/AN/AN/A
BusinessGroupIDEdm.Int32truetrue false N/AN/AN/AN/AN/A
EndDateEdm.DateTimeOffsettruefalse false N/AN/AN/AN/AN/AIsOnlyDate
IDEdm.Int32falsetrue false N/AN/AN/AN/AN/A
StartDateEdm.DateTimeOffsettruefalse false N/AN/AN/AN/AN/AIsOnlyDate

AreaBusinessGroupMap Navigational Properties

PropertyType
AreaNlyte.Model.Area
BusinessGroupNlyte.Model.BusinessGroup



AreaStatus Entity

Verb(s)Required Permission(s)LinkDescription
GetWS-ReadRoomPlan
PatchWS-ModifyRoomPlan
PutWS-ModifyRoomPlan
DeleteWS-ModifyRoomPlan
PostWS-ModifyRoomPlan

Key(s)
ID

AreaStatus Structural Properties

PropertyTypeNullableMandatoryRead-OnlyString lengthMin ValueMax ValuePrecisionMax Dec PlacesIs Only DateDescription
DescriptionEdm.Stringfalsetrue false 100N/AN/AN/AN/A
IDEdm.Int32falsefalse false N/AN/AN/AN/AN/A

AreaStatus Navigational Properties

No navigational properties


AreaSupportGroupMap Entity

Verb(s)Required Permission(s)LinkDescription
GetWS-ReadRoomPlan
PatchWS-ModifyRoomPlan
PutWS-ModifyRoomPlan
DeleteWS-ModifyRoomPlan
PostWS-ModifyRoomPlan

Key(s)
ID

AreaSupportGroupMap Structural Properties

PropertyTypeNullableMandatoryRead-OnlyString lengthMin ValueMax ValuePrecisionMax Dec PlacesIs Only DateDescription
AreaMarkerIDEdm.Int32truefalse true N/AN/AN/AN/AN/A
IDEdm.Int32falsetrue false N/AN/AN/AN/AN/A
SupportGroupIDEdm.Int32truetrue false N/AN/AN/AN/AN/A

AreaSupportGroupMap Navigational Properties

PropertyType
AreaNlyte.Model.Area
SupportGroupNlyte.Model.SupportGroup



AreaUsage Entity

Verb(s)Required Permission(s)LinkDescription
GetWS-ReadRoomPlan
PatchWS-ModifyRoomPlan
PutWS-ModifyRoomPlan
DeleteWS-ModifyRoomPlan
PostWS-ModifyRoomPlan

Key(s)
ID

AreaUsage Structural Properties

PropertyTypeNullableMandatoryRead-OnlyString lengthMin ValueMax ValuePrecisionMax Dec PlacesIs Only DateDescription
DescriptionEdm.Stringfalsetrue false 100N/AN/AN/AN/A
IDEdm.Int32falsefalse false N/AN/AN/AN/AN/A

AreaUsage Navigational Properties

No navigational properties


Asset Entity - Entity representing a generic asset, acting as base class for specific asset types.

Verb(s)Required Permission(s)LinkDescription
GetWS-ReadCabinet,WS-ReadServer,WS-ReadUPS,WS-ReadNetwork,WS-ReadPeripheral,WS-ReadStaticSwitch,WS-ReadReceptacle,WS-ReadKVMSwitch,WS-ReadAuxiliary,WS-ReadAirConditioning,WS-ReadChassis,WS-ReadPDU,WS-ReadPowerStripintegration/api/odata/Assets, integration/api/odata/Assets({key})

Key(s)
AssetID

Asset Structural Properties

PropertyTypeNullableMandatoryRead-OnlyString lengthMin ValueMax ValuePrecisionMax Dec PlacesIs Only DateDescription
ALCAddressEdm.Stringtruefalse false 200N/AN/AN/AN/A
AssetIDEdm.Int32falsefalse false N/AN/AN/AN/AN/APrimary key identifying the asset
AssetNameEdm.Stringtruetrue false 80N/AN/AN/AN/A
AssetNumberEdm.Int32truefalse true N/AN/AN/AN/AN/AProperty used to identify a pair of assets representing bi-state assets.
CabinetAssetIDEdm.Int32truefalse true N/AN/AN/AN/AN/AForeign key identifying the asset of type cabinet, in which the current asset is mounted..
CommPortEdm.Stringtruefalse false 200N/AN/AN/AN/A
CostCenterEdm.Stringtruefalse false 255N/AN/AN/AN/A
CreationDateEdm.DateTimeOffsettruefalse true N/AN/AN/AN/AN/AIsOnlyDateRead-only property, representing the date the asset was created.
CSVAddressEdm.Stringtruefalse false 200N/AN/AN/AN/A
DamagedRFIDTagEdm.Stringtruefalse false 255N/AN/AN/AN/A
DecommissionDateEdm.DateTimeOffsettruefalse true N/AN/AN/AN/AN/ARead-only property, representing the date the asset was decommissioned.
DeviceInstanceEdm.Int32truefalse false N/AN/AN/AN/AN/A
GridReferenceEdm.Stringtruefalse false 15N/AN/AN/AN/AGrid reference information, defined in the room planner
GridReferenceColumnEdm.Stringtruefalse false 10N/AN/AN/AN/AGrid reference information, defined in the room planner
GridReferenceLayerEdm.Stringtruefalse false 50N/AN/AN/AN/AString representing the mounting type: null, Cabinet. Cabinet if is mounted directly in a cabinet or its parent is mounted. a cabinet.
GridReferenceRowEdm.Stringtruefalse false 10N/AN/AN/AN/AGrid reference information, defined in the room planner
IsStaticSwitchEnabledEdm.Booleanfalsefalse true N/AN/AN/AN/AN/AUsed 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.
IsTemplateRelatedEdm.Booleanfalsefalse true N/AN/AN/AN/AN/ATrue if is an asset template
JCIAddressEdm.Stringtruefalse false 200N/AN/AN/AN/A
JSONAddressEdm.Stringtruefalse false 200N/AN/AN/AN/A
LastAssetExplorerScanDateEdm.DateTimeOffsettruefalse false N/AN/AN/AN/AN/A
LastScannedEdm.Stringtruefalse false 255N/AN/AN/AN/A
LocationGroupIDEdm.Int32truefalse false N/AN/AN/AN/AN/AForeign key identifying the asset location
LocationGroupOrChildrenIDEdm.Int32falsefalse false N/AN/AN/AN/AN/A
MaterialIDEdm.Int32falsetrue false N/AN/AN/AN/AN/AThe material id from which the asset was created.
ModbusSlaveIDEdm.Int32truefalse false N/AN/AN/AN/AN/A
ModiusAddressEdm.Stringtruefalse false 200N/AN/AN/AN/A
ObjectInstanceEdm.Int32truefalse false N/AN/AN/AN/AN/A
OPCMachineEdm.Stringtruefalse false 200N/AN/AN/AN/A
OPCServerEdm.Stringtruefalse false 200N/AN/AN/AN/A
OperationalDateEdm.DateTimeOffsettruefalse false N/AN/AN/AN/AN/AIsOnlyDate
OperationalStatusNlyte.Model.OperationalStatusEnumfalsetrue false N/AN/AN/AN/AN/AReflects the current state and/or planned future state. Together with the Record Status, they give the user the exact life-cycle status.
PacketPowerIDEdm.Stringtruefalse false 50N/AN/AN/AN/A
PollTypeNlyte.Model.PollTypeEnumtruefalse false N/AN/AN/AN/AN/A
PONumberEdm.Stringtruefalse false 255N/AN/AN/AN/A
PowerStateNlyte.Model.PowerStateEnumtruefalse false N/AN/AN/AN/AN/AEntity is powered or not.
PRNumberEdm.Stringtruefalse false 255N/AN/AN/AN/A
PurchaseDateEdm.DateTimeOffsettruefalse false N/AN/AN/AN/AN/AIsOnlyDate
PurchasePriceEdm.Decimalfalsefalse false N/A099999999999.99132
RecordStatusNlyte.Model.RecordStatusEnumfalsetrue false N/AN/AN/AN/AN/AReflects 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.
RFIDTagEdm.Stringtruefalse false 255N/AN/AN/AN/A
SAPAssetNumberEdm.Stringtruefalse false 255N/AN/AN/AN/AProperty used to identify a pair of assets representing bi-state assets.
SerialNumberEdm.Stringtruefalse false 50N/AN/AN/AN/A
SubStatusIDEdm.Int32truefalse false N/AN/AN/AN/AN/ASub-status defined in the administration area.
TagEdm.Stringtruefalse false 255N/AN/AN/AN/A
TemplateIDEdm.Int32truefalse true N/AN/AN/AN/AN/AThe template to which the asset is associated.
TridiumAddressEdm.Stringtruefalse false 200N/AN/AN/AN/A
UMountingIDEdm.Int32truefalse true N/AN/AN/AN/AN/AThe foreign key identifying the entity providing details about the Cabinet U in which an asset is mounted.
UniqueAssetNameEdm.Stringtruefalse true 1000N/AN/AN/AN/ARepresents the asset name concatenated with the location ( room, area, floor, building city)
XMLAddressEdm.Stringtruefalse false 200N/AN/AN/AN/A

Asset Navigational Properties

PropertyType
AssetDisplayLocationNlyte.Model.AssetDisplayLocation
AssetIPAddressMapCollection(Nlyte.Model.AssetIPAddressMap)
AssetMountingNlyte.Model.AssetMounting
AssetTemplateNlyte.Model.AssetTemplate
AssociatedAssetsCollection(Nlyte.Model.AssetAssociationMap)
CabinetNlyte.Model.Cabinet
CustomFieldsCollection(Nlyte.Model.CustomField)
FilesCollection(Nlyte.Model.AssetFile)
GraphsCollection(Nlyte.Model.Graph)
InternalEquipmentItemsCollection(Nlyte.Model.InternalEquipmentItem)
LastAuditorAccountNlyte.Model.UserAccount
LocationGroupNlyte.Model.LocationGroup
MaintenanceNlyte.Model.Maintenance
MaterialNlyte.Model.Material
NetworksCollection(Nlyte.Model.Network)
NotesCollection(Nlyte.Model.AssetNote)
OwnershipCollection(Nlyte.Model.BusinessGroupAssetMap)
SubStatusNlyte.Model.SubStatus
SupportCollection(Nlyte.Model.SupportGroupAssetMap)
UMountingNlyte.Model.UMounting
WarrantyNlyte.Model.Warranty



AssetAndHost Entity - Generic entity representing all asset types and hosts

Verb(s)Required Permission(s)LinkDescription
GetWS-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-ReadServerHostintegration/api/odata/AssetsAndHosts, integration/api/odata/AssetsAndHosts({key})

Key(s)
AssetTypeID
AssetID

AssetAndHost Structural Properties

PropertyTypeNullableMandatoryRead-OnlyString lengthMin ValueMax ValuePrecisionMax Dec PlacesIs Only DateDescription
AssetIDEdm.Int32truefalse false N/AN/AN/AN/AN/APrimary key identifying the asset
AssetNameEdm.Stringtruetrue false N/AN/AN/AN/AN/A
AssetNumberEdm.Int32truefalse true N/AN/AN/AN/AN/A
AssetTypeIDEdm.Int32falsefalse true N/AN/AN/AN/AN/A
CabinetAssetIDEdm.Int32truefalse true N/AN/AN/AN/AN/AForeign key identifying the asset of type cabinet, in which the current asset is mounted..
CabinetAssetNameEdm.Stringtruefalse false N/AN/AN/AN/AN/A
CabinetUNumberEdm.Int32truefalse false N/AN/AN/AN/AN/AThe U on which the asset is mounted
CabinetUsageIDEdm.Int32truefalse false N/AN/AN/AN/AN/A
ChassisMountedAssetMapIDEdm.Int32truefalse true N/AN/AN/AN/AN/A
CostCenterEdm.Stringtruefalse false N/AN/AN/AN/AN/A
CreationDateEdm.DateTimeOffsettruefalse true N/AN/AN/AN/AN/AIsOnlyDateRead-only property, representing the date the asset was created.
DuplicateLocationGroupNameEdm.Stringtruefalse false N/AN/AN/AN/AN/AThe unique location name, having the name as a concatenation of last hierarchical location names.
GridReferenceEdm.Stringtruefalse false N/AN/AN/AN/AN/AGrid reference information, defined in the room planner
GridReferenceColumnEdm.Stringtruefalse false N/AN/AN/AN/AN/AGrid reference information, defined in the room planner
GridReferenceRowEdm.Stringtruefalse false N/AN/AN/AN/AN/AGrid reference information, defined in the room planner
HeatingLimitEdm.Doubletruefalse false N/AN/AN/AN/AN/A
HeatThresholdEdm.Doubletruefalse false N/AN/AN/AN/AN/A
IsTemplateRelatedEdm.Booleanfalsefalse true N/AN/AN/AN/AN/ATrue if is an asset template
LocationGroupIDEdm.Int32truefalse false N/AN/AN/AN/AN/AForeign key identifying the asset location
LocationGroupNameEdm.Stringtruefalse false N/AN/AN/AN/AN/A
LocationGroupOrChildrenIDEdm.Int32falsefalse false N/AN/AN/AN/AN/A
MaterialTypeEdm.Stringtruefalse false N/AN/AN/AN/AN/A
MaterialTypeIDNlyte.Model.MaterialTypeEnumfalsefalse false N/AN/AN/AN/AN/A
MountingSideNlyte.Model.MountingSidetruefalse false N/AN/AN/AN/AN/ARepresents the mounting side, property of the asset that holds the mountable asset.
OperationalDateEdm.DateTimeOffsettruefalse false N/AN/AN/AN/AN/AIsOnlyDate
OperationalStatusNlyte.Model.OperationalStatusEnumfalsetrue false N/AN/AN/AN/AN/AReflects the current state and/or planned future state. Together with the Record Status, they give the user the exact life-cycle status.
PONumberEdm.Stringtruefalse false N/AN/AN/AN/AN/A
PRNumberEdm.Stringtruefalse false N/AN/AN/AN/AN/A
RecordStatusNlyte.Model.RecordStatusEnumfalsetrue false N/AN/AN/AN/AN/AReflects 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.
SAPAssetNumberEdm.Stringtruefalse false N/AN/AN/AN/AN/AProperty used to identify a pair of assets representing bi-state assets.
SerialNumberEdm.Stringtruefalse false N/AN/AN/AN/AN/A
SubStatusIDEdm.Int32truefalse false N/AN/AN/AN/AN/ASub-status defined in the administration area.

AssetAndHost Navigational Properties

PropertyType
AssetNlyte.Model.Asset
CabinetUsageNlyte.Model.CabinetUsage
ChassisMountedAssetMapNlyte.Model.ChassisMountedAssetMap
IPAddressMapsCollection(Nlyte.Model.AssetAndHostIPAddressMap)
LocationGroupNlyte.Model.LocationGroup
ServerHostNlyte.Model.ServerHost
SubStatusNlyte.Model.SubStatus



AssetAndHostIPAddressMap Entity - Entity representing the association between an asset and an IP Address

Verb(s)Required Permission(s)LinkDescription
GetWS-ReadAssetIPAddressMap,WS-ReadServerHostIPAddressMap

Key(s)
AssetAndHostIPAddressMapID

AssetAndHostIPAddressMap Structural Properties

PropertyTypeNullableMandatoryRead-OnlyString lengthMin ValueMax ValuePrecisionMax Dec PlacesIs Only DateDescription
AssetAndHostIPAddressMapIDEdm.Int32falsefalse false N/AN/AN/AN/AN/A
AssetIDEdm.Int32truefalse false N/AN/AN/AN/AN/AForeign key for the asset/host for which the IP Address was defined
AssetTypeIDEdm.Int32truefalse false N/AN/AN/AN/AN/AForeign key for the asset/host for which the IP Address was defined
IPAddressIDEdm.Int32truefalse false N/AN/AN/AN/AN/AForeign key for the IP Address

AssetAndHostIPAddressMap Navigational Properties

PropertyType
AssetAndHostNlyte.Model.AssetAndHost
IPAddressNlyte.Model.IPAddress



AssetAssociationMap Entity

Verb(s)Required Permission(s)LinkDescription
DeleteWS-ModifyAssetAssociationMap
PostWS-AddAssetAssociationMap
PostWithKeyWS-AddAssetAssociationMap
GetWS-ReadAssetAssociationMap

Key(s)
AssetAssociationMapID

AssetAssociationMap Structural Properties

PropertyTypeNullableMandatoryRead-OnlyString lengthMin ValueMax ValuePrecisionMax Dec PlacesIs Only DateDescription
AssetAssociationMapIDEdm.Int32falsefalse false N/AN/AN/AN/AN/A
AssetIDEdm.Int32truefalse false N/AN/AN/AN/AN/A
AssociatedAssetIDEdm.Int32falsefalse false N/AN/AN/AN/AN/A

AssetAssociationMap Navigational Properties

PropertyType
AssetNlyte.Model.Asset
AssociatedAssetNlyte.Model.Asset
NotesCollection(Nlyte.Model.AssetAssociationMapNote)



AssetAssociationMapNote Entity : Note

Verb(s)Required Permission(s)LinkDescription
PostWS-AddNote
PatchWS-ModifyNote
DeleteWS-ModifyNote
GetWS-ReadNote

Key(s)
NoteID

AssetAssociationMapNote Structural Properties

No structural properties

AssetAssociationMapNote Navigational Properties

No navigational properties


AssetDisplayLocation Entity

Verb(s)Required Permission(s)LinkDescription

Key(s)
DisplayLocationID

AssetDisplayLocation Structural Properties

PropertyTypeNullableMandatoryRead-OnlyString lengthMin ValueMax ValuePrecisionMax Dec PlacesIs Only DateDescription
DisplayLocationIDEdm.Int32falsefalse false N/AN/AN/AN/AN/A
DisplayLocationNameEdm.Stringfalsetrue false 50N/AN/AN/AN/A

AssetDisplayLocation Navigational Properties

No navigational properties


AssetFile Entity : File

Verb(s)Required Permission(s)LinkDescription
GetWS-ReadFile
DeleteWS-ModifyFile

Key(s)
Name

AssetFile Structural Properties

No structural properties

AssetFile Navigational Properties

No navigational properties


AssetIPAddressMap Entity - Entity representing the association between an asset and an IP Address

Verb(s)Required Permission(s)LinkDescription
GetWS-ReadAssetIPAddressMap
DeleteWS-ModifyAssetIPAddressMap
PatchWS-ModifyAssetIPAddressMap
PostWithKeyWS-ModifyAssetIPAddressMap
PostWS-AddAssetIPAddressMap

Key(s)
AssetIPAddressMapID

AssetIPAddressMap Structural Properties

PropertyTypeNullableMandatoryRead-OnlyString lengthMin ValueMax ValuePrecisionMax Dec PlacesIs Only DateDescription
AssetIDEdm.Int32truefalse true N/AN/AN/AN/AN/AForeign key for the asset for which the IP Address was defined
AssetIPAddressMapIDEdm.Int32falsefalse false N/AN/AN/AN/AN/A
IPAddressIDEdm.Int32truefalse false N/AN/AN/AN/AN/AForeign key for the IP Address

AssetIPAddressMap Navigational Properties

PropertyType
AssetNlyte.Model.Asset
IPAddressNlyte.Model.IPAddress



AssetMapping Entity

Verb(s)Required Permission(s)LinkDescription

Key(s)
AssetMapID

AssetMapping Structural Properties

PropertyTypeNullableMandatoryRead-OnlyString lengthMin ValueMax ValuePrecisionMax Dec PlacesIs Only DateDescription
AssetIDEdm.Int32truefalse false N/AN/AN/AN/AN/A
AssetMapIDEdm.Int32falsefalse false N/AN/AN/AN/AN/A
AssetNumberEdm.Int32falsefalse false N/AN/AN/AN/AN/A
CreatedEdm.DateTimeOffsetfalsefalse false N/AN/AN/AN/AN/AIsOnlyDate
DiscoveredEdm.DateTimeOffsettruefalse false N/AN/AN/AN/AN/AIsOnlyDate
ExternalIDEdm.Stringtruefalse false 512N/AN/AN/AN/A
ExternalNameEdm.Stringtruefalse false 70N/AN/AN/AN/A
LastUpdatedEdm.DateTimeOffsetfalsefalse false N/AN/AN/AN/AN/AIsOnlyDate
ProviderIDEdm.Guidtruefalse false N/AN/AN/AN/AN/A
URLEdm.Stringtruefalse false 2048N/AN/AN/AN/A

AssetMapping Navigational Properties

PropertyType
AssetNlyte.Model.Asset



AssetMounting Entity - Entity representing the association between the current asset and the asset in which the current asset is mounted.

Verb(s)Required Permission(s)LinkDescription
GetWS-ReadAssetMounting

Key(s)
MountedAssetID

AssetMounting Structural Properties

PropertyTypeNullableMandatoryRead-OnlyString lengthMin ValueMax ValuePrecisionMax Dec PlacesIs Only DateDescription
AssetIDEdm.Int32falsefalse true N/AN/AN/AN/AN/AAssetID of the asset that holds the mountable asset.
AssetNameEdm.Stringtruefalse true N/AN/AN/AN/AN/AAssetName of the asset that holds the mountable asset.
AssetNumberEdm.Int32falsefalse true N/AN/AN/AN/AN/AAssetNumber of the asset that holds the mountable asset.
LocationGroupIDEdm.Int32falsefalse false N/AN/AN/AN/AN/A
MountedAssetIDEdm.Int32truefalse true N/AN/AN/AN/AN/ARepresents the AssetID of the asset that is mounted.
MountingSideNlyte.Model.MountingSidefalse false
RecordStatusNlyte.Model.RecordStatusEnumfalse false

AssetMounting Navigational Properties

PropertyType
AssetNlyte.Model.Asset



AssetNote Entity : Note

Verb(s)Required Permission(s)LinkDescription
PostWS-AddNote
PatchWS-ModifyNote
DeleteWS-ModifyNote
GetWS-ReadNote

Key(s)
NoteID

AssetNote Structural Properties

No structural properties

AssetNote Navigational Properties

No navigational properties


AssetRealTimeData Entity

Verb(s)Required Permission(s)LinkDescription
GetWS-ReadAssetRealtimeDataintegration/api/odata/AssetRealTimeData, integration/api/odata/AssetRealTimeData({key})

Key(s)
AssetRealtimeDataID

AssetRealTimeData Structural Properties

PropertyTypeNullableMandatoryRead-OnlyString lengthMin ValueMax ValuePrecisionMax Dec PlacesIs Only DateDescription
AssetIDEdm.Int32falsefalse false N/AN/AN/AN/AN/A
AssetRealtimeDataIDEdm.Int32falsefalse false N/AN/AN/AN/AN/A
LastUpdatedEdm.DateTimeOffsetfalsefalse false N/AN/AN/AN/AN/A
LocationGroupIDEdm.Int32falsefalse false N/AN/AN/AN/AN/A
ProviderIDEdm.Int32falsefalse false N/AN/AN/AN/AN/A
RealtimeLoadEdm.Decimaltruefalse false N/AN/AN/AN/AN/A
RealtimeLoadAverageEdm.Decimaltruefalse false N/AN/AN/AN/AN/A
RealtimeLoadMaxEdm.Decimaltruefalse false N/AN/AN/AN/AN/A
RealtimeLoadMinEdm.Decimaltruefalse false N/AN/AN/AN/AN/A
RealtimePowerEdm.Decimaltruefalse false N/AN/AN/AN/AN/A
RealtimePowerAverageEdm.Decimaltruefalse false N/AN/AN/AN/AN/A
RealtimePowerMaxEdm.Decimaltruefalse false N/AN/AN/AN/AN/A
RealtimePowerMinEdm.Decimaltruefalse false N/AN/AN/AN/AN/A
RealtimeTotalEnergyEdm.Decimaltruefalse false N/AN/AN/AN/AN/A
RealtimeVoltageEdm.Decimaltruefalse false N/AN/AN/AN/AN/A
RealtimeVoltageAverageEdm.Decimaltruefalse false N/AN/AN/AN/AN/A
RealtimeVoltageMaxEdm.Decimaltruefalse false N/AN/AN/AN/AN/A
RealtimeVoltageMinEdm.Decimaltruefalse false N/AN/AN/AN/AN/A

AssetRealTimeData Navigational Properties

No navigational properties


AssetRealTimePhaseData Entity

Verb(s)Required Permission(s)LinkDescription
GetWS-ReadAssetRealtimePhaseDataintegration/api/odata/AssetRealTimePhaseData, integration/api/odata/AssetRealTimePhaseData({key})

Key(s)
AssetRealtimePhaseDataID

AssetRealTimePhaseData Structural Properties

PropertyTypeNullableMandatoryRead-OnlyString lengthMin ValueMax ValuePrecisionMax Dec PlacesIs Only DateDescription
AssetIDEdm.Int32falsefalse false N/AN/AN/AN/AN/A
AssetRealtimePhaseDataIDEdm.Int32falsefalse false N/AN/AN/AN/AN/A
LastUpdatedEdm.DateTimeOffsetfalsefalse false N/AN/AN/AN/AN/A
LocationGroupIDEdm.Int32falsefalse false N/AN/AN/AN/AN/A
Phase1RealtimeLoadEdm.Decimaltruefalse false N/AN/AN/AN/AN/A
Phase1RealtimeLoadAverageEdm.Decimaltruefalse false N/AN/AN/AN/AN/A
Phase1RealtimeLoadMaxEdm.Decimaltruefalse false N/AN/AN/AN/AN/A
Phase1RealtimeLoadMinEdm.Decimaltruefalse false N/AN/AN/AN/AN/A
Phase1RealtimePowerEdm.Decimaltruefalse false N/AN/AN/AN/AN/A
Phase1RealtimePowerAverageEdm.Decimaltruefalse false N/AN/AN/AN/AN/A
Phase1RealtimePowerMaxEdm.Decimaltruefalse false N/AN/AN/AN/AN/A
Phase1RealtimePowerMinEdm.Decimaltruefalse false N/AN/AN/AN/AN/A
Phase1RealtimeVoltageEdm.Decimaltruefalse false N/AN/AN/AN/AN/A
Phase1RealtimeVoltageAverageEdm.Decimaltruefalse false N/AN/AN/AN/AN/A
Phase1RealtimeVoltageMaxEdm.Decimaltruefalse false N/AN/AN/AN/AN/A
Phase1RealtimeVoltageMinEdm.Decimaltruefalse false N/AN/AN/AN/AN/A
Phase2RealtimeLoadEdm.Decimaltruefalse false N/AN/AN/AN/AN/A
Phase2RealtimeLoadAverageEdm.Decimaltruefalse false N/AN/AN/AN/AN/A
Phase2RealtimeLoadMaxEdm.Decimaltruefalse false N/AN/AN/AN/AN/A
Phase2RealtimeLoadMinEdm.Decimaltruefalse false N/AN/AN/AN/AN/A
Phase2RealtimePowerEdm.Decimaltruefalse false N/AN/AN/AN/AN/A
Phase2RealtimePowerAverageEdm.Decimaltruefalse false N/AN/AN/AN/AN/A
Phase2RealtimePowerMaxEdm.Decimaltruefalse false N/AN/AN/AN/AN/A
Phase2RealtimePowerMinEdm.Decimaltruefalse false N/AN/AN/AN/AN/A
Phase2RealtimeVoltageEdm.Decimaltruefalse false N/AN/AN/AN/AN/A
Phase2RealtimeVoltageAverageEdm.Decimaltruefalse false N/AN/AN/AN/AN/A
Phase2RealtimeVoltageMaxEdm.Decimaltruefalse false N/AN/AN/AN/AN/A
Phase2RealtimeVoltageMinEdm.Decimaltruefalse false N/AN/AN/AN/AN/A
Phase3RealtimeLoadEdm.Decimaltruefalse false N/AN/AN/AN/AN/A
Phase3RealtimeLoadAverageEdm.Decimaltruefalse false N/AN/AN/AN/AN/A
Phase3RealtimeLoadMaxEdm.Decimaltruefalse false N/AN/AN/AN/AN/A
Phase3RealtimeLoadMinEdm.Decimaltruefalse false N/AN/AN/AN/AN/A
Phase3RealtimePowerEdm.Decimaltruefalse false N/AN/AN/AN/AN/A
Phase3RealtimePowerAverageEdm.Decimaltruefalse false N/AN/AN/AN/AN/A
Phase3RealtimePowerMaxEdm.Decimaltruefalse false N/AN/AN/AN/AN/A
Phase3RealtimePowerMinEdm.Decimaltruefalse false N/AN/AN/AN/AN/A
Phase3RealtimeVoltageEdm.Decimaltruefalse false N/AN/AN/AN/AN/A
Phase3RealtimeVoltageAverageEdm.Decimaltruefalse false N/AN/AN/AN/AN/A
Phase3RealtimeVoltageMaxEdm.Decimaltruefalse false N/AN/AN/AN/AN/A
Phase3RealtimeVoltageMinEdm.Decimaltruefalse false N/AN/AN/AN/AN/A
ProviderIDEdm.Int32falsefalse false N/AN/AN/AN/AN/A

AssetRealTimePhaseData Navigational Properties

No navigational properties


AssetSummaryDC Entity - Entity representing an asset identified by fewer properties.

Verb(s)Required Permission(s)LinkDescription

Key(s)
AssetID

AssetSummaryDC Structural Properties

PropertyTypeNullableMandatoryRead-OnlyString lengthMin ValueMax ValuePrecisionMax Dec PlacesIs Only DateDescription
AssetIDEdm.Int32falsefalse false N/AN/AN/AN/AN/A
AssetNameEdm.Stringtruefalse false N/AN/AN/AN/AN/A
AssetNumberEdm.Int32falsefalse false N/AN/AN/AN/AN/A
CabinetAssetIDEdm.Int32falsefalse false N/AN/AN/AN/AN/AKey identifying the asset of type cabinet, in which the current asset is mounted..
CabinetAssetNameEdm.Stringtruefalse false N/AN/AN/AN/AN/A
DuplicateLocationGroupNameEdm.Stringtruefalse false N/AN/AN/AN/AN/AThe unique location name, having the name as a concatenation of last hierarchical location names.
LocationGroupIDEdm.Int32falsefalse false N/AN/AN/AN/AN/AForeign key identifying the asset location
MaterialIDEdm.Int32truefalse false N/AN/AN/AN/AN/AThe key that identifies the material from which the asset was created.
MaterialNameEdm.Stringtruefalse false N/AN/AN/AN/AN/A
MaterialSubTypeIDEdm.Int32truefalse false N/AN/AN/AN/AN/A
MaterialTypeIDEdm.Int32falsefalse false N/AN/AN/AN/AN/A
TypeNameEdm.Stringtruefalse false N/AN/AN/AN/AN/A

AssetSummaryDC Navigational Properties

No navigational properties


AssetTemplate Entity - Entity representing an asset template.

Verb(s)Required Permission(s)LinkDescription
PostWS-AddAssetTemplateintegration/api/odata/AssetTemplates
GetWS-ReadAssetTemplateintegration/api/odata/AssetTemplates, integration/api/odata/AssetTemplates({key})
PatchWS-ModifyAssetTemplateintegration/api/odata/AssetTemplates({key})

Key(s)
Id

AssetTemplate Structural Properties

PropertyTypeNullableMandatoryRead-OnlyString lengthMin ValueMax ValuePrecisionMax Dec PlacesIs Only DateDescription
AssetIdsCollection(Edm.Int32)falsetrue true N/AN/AN/AN/AN/AA collection of asset IDs included in the template
CreationDateEdm.DateTimeOffsetfalsefalse true N/AN/AN/AN/AN/AIsOnlyDate
DescriptionEdm.Stringtruefalse false 800N/AN/AN/AN/A
IdEdm.Int32falsefalse true N/AN/AN/AN/AN/A
IncludePeripheralsEdm.Booleantruetrue true N/AN/AN/AN/AN/A
LastUsedDateEdm.DateTimeOffsettruefalse true N/AN/AN/AN/AN/AIsOnlyDate
NameEdm.Stringtruetrue false 40N/AN/AN/AN/A
PurchasePriceEdm.Decimaltruefalse false N/A099999999999.99132
TemplateStatusIdNlyte.Model.AssetTemplateStatusfalsefalse true N/AN/AN/AN/AN/A
TemplateTypeIdNlyte.Model.AssetTemplateTypefalsetrue true N/AN/AN/AN/AN/ACan be for a single asset or floor standing assets
TotalMPAFEdm.Decimalfalsefalse true N/AN/AN/AN/AN/A
TotalWeightEdm.Doublefalsefalse true N/AN/AN/AN/AN/A
UsedCountEdm.Int32falsefalse true N/AN/AN/AN/AN/A

AssetTemplate Navigational Properties

PropertyType
AssetTemplateJobsCollection(Nlyte.Model.AssetTemplateJob)



AssetTemplateInstance Entity - Entity used when instantiating assets from a template

Verb(s)Required Permission(s)LinkDescription
PostWS-BeginInstantiateTemplateintegration/api/odata/AssetTemplateInstances

Key(s)
Id

AssetTemplateInstance Structural Properties

PropertyTypeNullableMandatoryRead-OnlyString lengthMin ValueMax ValuePrecisionMax Dec PlacesIs Only DateDescription
AssetIdsCollection(Edm.Int32)falsefalse false N/AN/AN/AN/AN/AA collection of asset IDs included in the for creating copies.
CreateCopyEdm.Booleanfalsefalse false N/AN/AN/AN/AN/ACreates a copy of the assets in the templates instead of creating new instances.
IdEdm.Int32falsefalse false N/AN/AN/AN/AN/A
InstanceCountEdm.Int32falsetrue false N/AN/AN/AN/AN/A
LocationGroupIdEdm.Int32truetrue false N/AN/AN/AN/AN/AForeign key identifying the asset location
OperationalStatusNlyte.Model.OperationalStatusEnumfalsetrue false N/AN/AN/AN/AN/AReflects 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.
RecordStatusNlyte.Model.RecordStatusEnumfalsetrue false N/AN/AN/AN/AN/AReflects 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.
TemplateIdEdm.Int32falsetrue false N/AN/AN/AN/AN/AThe associated template

AssetTemplateInstance Navigational Properties

PropertyType
LocationGroupNlyte.Model.LocationGroup



AssetTemplateJob Entity - Entity used as a step in template creation or instantiation

Verb(s)Required Permission(s)LinkDescription
GetWS-ReadAssetTemplateintegration/api/odata/AssetTemplateJobs, integration/api/odata/AssetTemplateJobs({key})

Key(s)
Id

AssetTemplateJob Structural Properties

PropertyTypeNullableMandatoryRead-OnlyString lengthMin ValueMax ValuePrecisionMax Dec PlacesIs Only DateDescription
EndDateEdm.DateTimeOffsettruefalse false N/AN/AN/AN/AN/A
IdEdm.Int32falsefalse false N/AN/AN/AN/AN/A
JobStatusIDNlyte.Model.AssetTemplateJobStatusfalsefalse false N/AN/AN/AN/AN/ATogether with the Progress property is showing the completion status.
JobTypeIDNlyte.Model.AssetTemplateJobTypefalsefalse false N/AN/AN/AN/AN/AShows the template job purpose
ProgressEdm.Decimalfalsefalse false N/AN/AN/AN/AN/AProperty that shows the completion percentage for template creation/instantiation
StartDateEdm.DateTimeOffsetfalsefalse false N/AN/AN/AN/AN/A
TemplateIDEdm.Int32truefalse false N/AN/AN/AN/AN/AThe associated template The template for which the job is active.

AssetTemplateJob Navigational Properties

PropertyType
AssetTemplateNlyte.Model.AssetTemplate
JobItemsCollection(Nlyte.Model.AssetTemplateJobItem)



AssetTemplateJobItem Entity

Verb(s)Required Permission(s)LinkDescription
GetWS-ReadAssetTemplate

Key(s)
NewAssetID

AssetTemplateJobItem Structural Properties

PropertyTypeNullableMandatoryRead-OnlyString lengthMin ValueMax ValuePrecisionMax Dec PlacesIs Only DateDescription
JobIDEdm.Int32truefalse false N/AN/AN/AN/AN/A
NewAssetIDEdm.Int32falsefalse false N/AN/AN/AN/AN/A

AssetTemplateJobItem Navigational Properties

PropertyType
AssetTemplateJobNlyte.Model.AssetTemplateJob



AssetUploaderJob Entity - Entity used as a step in asset auto loader functionality

Verb(s)Required Permission(s)LinkDescription
GetWS-AssetUploadintegration/api/odata/AssetUploaderJobs, integration/api/odata/AssetUploaderJobs({key})
PostWS-AssetUploadintegration/api/odata/AssetUploaderJobs
DeleteWS-AssetUploadintegration/api/odata/AssetUploaderJobs({key})

Key(s)
Id

AssetUploaderJob Structural Properties

PropertyTypeNullableMandatoryRead-OnlyString lengthMin ValueMax ValuePrecisionMax Dec PlacesIs Only DateDescription
EndDateEdm.DateTimeOffsettruefalse false N/AN/AN/AN/AN/A
ErrorMessageEdm.Stringtruefalse false N/AN/AN/AN/AN/A
IdEdm.Int32falsefalse false N/AN/AN/AN/AN/A
JobCancelUserIdEdm.Int32truefalse false N/AN/AN/AN/AN/A
JobRequestUrlEdm.Stringtruefalse false N/AN/AN/AN/AN/AShows the url address of the endpoint used for uploading the asset auto loader file
JobRequestUserIdEdm.Int32truefalse false N/AN/AN/AN/AN/A
JobStatusIDNlyte.Model.AssetUploaderJobStatusfalsefalse false N/AN/AN/AN/AN/ATogether with the Progress property is showing the completion status.
ProgressEdm.Decimalfalsefalse false N/AN/AN/AN/AN/AProperty that shows the completion percentage for number of rows processed from the uploaded asset auto load file
StartDateEdm.DateTimeOffsettruefalse false N/AN/AN/AN/AN/A
UploadDateEdm.DateTimeOffsetfalsefalse false N/AN/AN/AN/AN/A
UploadedFileIdEdm.Int32falsefalse false N/AN/AN/AN/AN/A
UploadedFileNameEdm.Stringtruefalse false N/AN/AN/AN/AN/A

AssetUploaderJob Navigational Properties

PropertyType
JobCancelUserNlyte.Model.UserAccount
JobItemsCollection(Nlyte.Model.AssetUploaderJobItem)
JobRequestUserNlyte.Model.UserAccount



AssetUploaderJobItem Entity

Verb(s)Required Permission(s)LinkDescription
PostWS-AssetUpload
DeleteWS-AssetUpload
GetWS-AssetUpload

Key(s)
Id

AssetUploaderJobItem Structural Properties

PropertyTypeNullableMandatoryRead-OnlyString lengthMin ValueMax ValuePrecisionMax Dec PlacesIs Only DateDescription
FileRowNrEdm.Int64falsefalse false N/AN/AN/AN/AN/A
IdEdm.Int64falsefalse false N/AN/AN/AN/AN/A
JobIDEdm.Int32truefalse false N/AN/AN/AN/AN/A
NewAssetIDEdm.Int32truefalse false N/AN/AN/AN/AN/A
ResponseMessagesEdm.Stringtruefalse false N/AN/AN/AN/AN/A
ResponseStatusCodeEdm.Int32truefalse false N/AN/AN/AN/AN/A

AssetUploaderJobItem Navigational Properties

PropertyType
AssetUploaderJobNlyte.Model.AssetUploaderJob



Assignee Entity

Verb(s)Required Permission(s)LinkDescription

Key(s)
ID

Assignee Structural Properties

PropertyTypeNullableMandatoryRead-OnlyString lengthMin ValueMax ValuePrecisionMax Dec PlacesIs Only DateDescription
AssigneeGroupsOfResourceIDEdm.Int32falsefalse true N/AN/AN/AN/AN/A
AssigneeTypeNlyte.Model.AssigneeTypefalsetrue false N/AN/AN/AN/AN/A
BusinessGroupIDEdm.Int32truefalse false N/AN/AN/AN/AN/A
GroupNameEdm.Stringtruefalse false N/AN/AN/AN/AN/A
IDEdm.Int32falsefalse false N/AN/AN/AN/AN/A
NameEdm.Stringtruefalse false N/AN/AN/AN/AN/A
ResourceIDEdm.Int32truefalse false N/AN/AN/AN/AN/A
ResourceNameEdm.Stringtruefalse false N/AN/AN/AN/AN/A
SupportGroupIDEdm.Int32truefalse false N/AN/AN/AN/AN/A

Assignee Navigational Properties

PropertyType
BusinessGroupNlyte.Model.BusinessGroup
ExclusionDatesCollection(Nlyte.Model.ExclusionDate)
ProcessesCollection(Nlyte.Model.Process)
ResourceNlyte.Model.Resource
ServiceRequestsCollection(Nlyte.Model.ServiceRequest)
SupportGroupNlyte.Model.SupportGroup
TaskInstancesCollection(Nlyte.Model.TaskInstance)
TasksCollection(Nlyte.Model.Task)
WorkingHoursCollection(Nlyte.Model.WorkingHours)



AuditLogInfo Entity

Verb(s)Required Permission(s)LinkDescription
GetWS-ReadAuditLog

Key(s)
EntityID

AuditLogInfo Structural Properties

PropertyTypeNullableMandatoryRead-OnlyString lengthMin ValueMax ValuePrecisionMax Dec PlacesIs Only DateDescription
EntityIDEdm.Int32falsefalse false N/AN/AN/AN/AN/A
RecordModifiedEdm.DateTimeOffsetfalsefalse false N/AN/AN/AN/AN/A
RecordModifiedByEdm.Stringtruefalse false N/AN/AN/AN/AN/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)LinkDescription
GetWS-ReadAuxiliaryintegration/api/odata/Auxiliaries, integration/api/odata/Auxiliaries({key})
PatchWS-ModifyAuxiliaryintegration/api/odata/Auxiliaries({key})
PostWithKeyWS-ModifyAuxiliaryintegration/api/odata/Auxiliaries({key})
DeleteWS-ModifyAuxiliaryintegration/api/odata/Auxiliaries({key})
PostWS-AddAuxiliaryintegration/api/odata/Auxiliaries

Key(s)
AssetID

Auxiliary Structural Properties

PropertyTypeNullableMandatoryRead-OnlyString lengthMin ValueMax ValuePrecisionMax Dec PlacesIs Only DateDescription
AuditDateEdm.DateTimeOffsettruefalse false N/AN/AN/AN/AN/A
AuditStatusCorrectEdm.Booleantruefalse false N/AN/AN/AN/AN/A
CurrentPowerFactorEdm.Decimaltruefalse true N/AN/AN/AN/AN/ARead-only property representing the percentage of power drawn by a PDD asset that is available to its consumers
IsMasterRedundancyDeviceEdm.Booleanfalsefalse false N/AN/AN/AN/AN/AValue inserted by the user
LastAuditorAccountIDEdm.Int32truefalse false N/AN/AN/AN/AN/A
LastTestDateEdm.DateTimeOffsettruefalse false N/AN/AN/AN/AN/AIsOnlyDate
OutputCountEdm.Int32falsefalse true N/AN/AN/AN/AN/A
PowerFactorOverrideEdm.Decimaltruefalse false N/A0132Value provided by the user, overriding the CurrentPowerFactor value
RealtimePowerFactorEdm.Decimaltruefalse true N/AN/AN/AN/AN/ARead-only value.

Auxiliary Navigational Properties

PropertyType
AuxiliaryMaterialNlyte.Model.AuxiliaryMaterial
UtilitiesCollection(Nlyte.Model.Supplier)
WiresCollection(Nlyte.Model.Wire)



AuxiliaryMaterial Entity : Material - Material type inheriting properties from the base type

Verb(s)Required Permission(s)LinkDescription
GetWS-ReadAuxiliaryMaterialintegration/api/odata/AuxiliaryMaterials, integration/api/odata/AuxiliaryMaterials({key})
PostWS-AddAuxiliaryMaterialintegration/api/odata/AuxiliaryMaterials
PostWithKeyWS-ModifyAuxiliaryMaterial
PatchWS-ModifyAuxiliaryMaterialintegration/api/odata/AuxiliaryMaterials({key})
DeleteWS-ModifyAuxiliaryMaterialintegration/api/odata/AuxiliaryMaterials({key})

Key(s)
MaterialID

AuxiliaryMaterial Structural Properties

PropertyTypeNullableMandatoryRead-OnlyString lengthMin ValueMax ValuePrecisionMax Dec PlacesIs Only DateDescription
CalculatedMaxKWEdm.Decimaltruefalse true N/AN/AN/AN/AN/ARead-only value, calculated based on the MaxKW and MaxKVA
DistributorPowerFactorEdm.Decimalfalsefalse true N/AN/AN/AN/AN/A
MaterialCategoryIDEdm.Int32truefalse false N/AN/AN/AN/AN/A
MaterialSubtypeIDEdm.Int32truefalse true N/AN/AN/AN/AN/AEach material type has its own sub-types, to properly identify the material and the asset created from the material.
MaxAEdm.Decimaltruefalse false N/A099999.99983
MaxKVAEdm.Decimaltruefalse false N/A099999999.9999124
MaxKWEdm.Decimaltruefalse false N/A099999999.9999124
MaxVEdm.Decimaltruefalse false N/A099999.99983
PowerTypeIDNlyte.Model.PowerTypeEnumtruefalse true N/AN/AN/AN/AN/APower type: phased or direct current
UHeightEdm.Int64falsefalse true N/AN/AN/AN/AN/A
WorkableFootPrintFrontEdm.Doublefalsefalse false N/A0999999999999.9999164
WorkableFootPrintHeightEdm.Doublefalsefalse false N/A0999999999999.9999164
WorkableFootPrintRearEdm.Doublefalsefalse false N/A0999999999999.9999164

AuxiliaryMaterial Navigational Properties

No navigational properties


BladeServerMaterial Entity : ServerMaterial - Material type inheriting properties from the base type

Verb(s)Required Permission(s)LinkDescription
GetWS-ReadServerMaterialintegration/api/odata/BladeServerMaterials, integration/api/odata/BladeServerMaterials({key})
PostWS-AddServerMaterialintegration/api/odata/BladeServerMaterials
PostWithKeyWS-ModifyServerMaterial
PatchWS-ModifyServerMaterialintegration/api/odata/BladeServerMaterials({key})
DeleteWS-ModifyServerMaterialintegration/api/odata/BladeServerMaterials({key})

Key(s)
MaterialID

BladeServerMaterial Structural Properties

PropertyTypeNullableMandatoryRead-OnlyString lengthMin ValueMax ValuePrecisionMax Dec PlacesIs Only DateDescription
MaterialCategoryIDEdm.Int32truefalse false N/AN/AN/AN/AN/A
PublishedPowerConsumptionEdm.Decimalfalsefalse false N/A0.00199963

BladeServerMaterial Navigational Properties

No navigational properties


BoardPDUMaterial Entity : PDUMaterial

Verb(s)Required Permission(s)LinkDescription
GetWS-ReadPDUMaterialintegration/api/odata/BoardPDUMaterials, integration/api/odata/BoardPDUMaterials({key})
PostWS-AddPDUMaterialintegration/api/odata/BoardPDUMaterials
PostWithKeyWS-ModifyPDUMaterial
PatchWS-ModifyPDUMaterialintegration/api/odata/BoardPDUMaterials({key})
DeleteWS-ModifyPDUMaterialintegration/api/odata/BoardPDUMaterials({key})

Key(s)
MaterialID

BoardPDUMaterial Structural Properties

No structural properties

BoardPDUMaterial Navigational Properties

No navigational properties


Breaker Entity - Entity providing details about a PDU breaker

Verb(s)Required Permission(s)LinkDescription
GetWS-ReadPDUBreakerintegration/api/odata/Breakers, integration/api/odata/Breakers({key})
DeleteWS-ModifyPDUBreakerintegration/api/odata/Breakers({key})
PatchWS-ModifyPDUBreakerintegration/api/odata/Breakers({key})
PostWithKeyWS-ModifyPDUBreaker
PostWS-AddPDUBreaker

Key(s)
BreakerID

Breaker Structural Properties

PropertyTypeNullableMandatoryRead-OnlyString lengthMin ValueMax ValuePrecisionMax Dec PlacesIs Only DateDescription
AmperageEdm.Int32truefalse false N/AN/AN/AN/AN/A
ApprovedByEdm.Stringtruefalse false 50N/AN/AN/AN/A
ApprovedDateEdm.DateTimeOffsettruefalse false N/AN/AN/AN/AN/AIsOnlyDate
BreakerIDEdm.Int32truefalse false N/AN/AN/AN/AN/A
BreakerNumberEdm.Int32falsefalse false N/AN/AN/AN/AN/A
BreakerPanelIDEdm.Int32truefalse true N/AN/AN/AN/AN/A
CurveEdm.Stringtruefalse false 3N/AN/AN/AN/A
GroundFaultDeviceEdm.Booleanfalsefalse false N/AN/AN/AN/AN/A
GroundFaultDeviceInitialTestDateEdm.DateTimeOffsettruefalse false N/AN/AN/AN/AN/AIsOnlyDate
GroundFaultDeviceLastTestDateEdm.DateTimeOffsettruefalse false N/AN/AN/AN/AN/AIsOnlyDate
GroundFaultDeviceTestResultEdm.Decimaltruefalse false N/A09999.999984
InstallationDateEdm.DateTimeOffsettruefalse false N/AN/AN/AN/AN/AIsOnlyDate
IsEmptyEdm.Booleanfalsefalse true N/AN/AN/AN/AN/A
LocationGroupIDEdm.Int32falsefalse true N/AN/AN/AN/AN/A
ManufacturerIDEdm.Int32truefalse false N/AN/AN/AN/AN/A
ModelEdm.Stringtruefalse false 30N/AN/AN/AN/A
NameEdm.Stringtruefalse false 140N/AN/AN/AN/A
PhaseColourEdm.Stringtruefalse false 255N/AN/AN/AN/A
PhaseColourIndexEdm.Int32truefalse true N/AN/AN/AN/AN/A
PhaseMasterBreakerIDEdm.Int32truefalse true N/AN/AN/AN/AN/A
PhaseMasterPositionEdm.Int32truefalse false N/AN/AN/AN/AN/A
PlannedServiceOffDescriptionEdm.Stringtruefalse false 250N/AN/AN/AN/A
PlannedServiceOffEndDateEdm.DateTimeOffsettruefalse false N/AN/AN/AN/AN/AIsOnlyDate
PlannedServiceOffStartDateEdm.DateTimeOffsettruefalse false N/AN/AN/AN/AN/AIsOnlyDate
PositionEdm.Int32falsefalse false N/AN/AN/AN/AN/A
PowerDateEdm.DateTimeOffsettruefalse false N/AN/AN/AN/AN/AIsOnlyDate
PowerTypeIDNlyte.Model.PowerTypeEnumtruefalse false N/AN/AN/AN/AN/APower type: phased or direct current
ReceptacleMaterialIDEdm.Int32truefalse false N/AN/AN/AN/AN/AThe key that identifies the material from which the parent asset was created.
TypeEdm.Stringtruefalse false 255N/AN/AN/AN/A

Breaker Navigational Properties

PropertyType
BreakerPanelNlyte.Model.BreakerPanel
ManufacturerNlyte.Model.Manufacturer
OutputConnectorsCollection(Nlyte.Model.OutputConnector)
ParentNlyte.Model.Breaker
ReceptacleMaterialNlyte.Model.ReceptacleMaterial



BreakerPanel Entity

Verb(s)Required Permission(s)LinkDescription
GetWS-ReadPDUPanelintegration/api/odata/BreakerPanels, integration/api/odata/BreakerPanels({key})
DeleteWS-ModifyPDUPanelintegration/api/odata/BreakerPanels({key})
PatchWS-ModifyPDUPanelintegration/api/odata/BreakerPanels({key})
PostWithKeyWS-ModifyPDUPanelintegration/api/odata/BreakerPanels({key})
PostWS-AddPDUPanelintegration/api/odata/BreakerPanels

Key(s)
BreakerPanelID

BreakerPanel Structural Properties

PropertyTypeNullableMandatoryRead-OnlyString lengthMin ValueMax ValuePrecisionMax Dec PlacesIs Only DateDescription
AssetIDEdm.Int32falsefalse false N/AN/AN/AN/AN/A
BreakerPanelIDEdm.Int32falsefalse false N/AN/AN/AN/AN/A
LocationGroupIDEdm.Int32falsefalse true N/AN/AN/AN/AN/A
NumberOfBreakersEdm.Int32truetrue false N/AN/AN/AN/AN/A
PanelIPAddressEdm.Stringtruefalse false 50N/AN/AN/AN/A
PanelModbusSlaveIDEdm.Stringtruefalse false 255N/AN/AN/AN/A
PanelNameEdm.Stringtruetrue false 50N/AN/AN/AN/A
PanelNEOProfileEdm.Stringtruefalse false 200N/AN/AN/AN/A
PanelNumberEdm.Int32falsetrue false N/AN/AN/AN/AN/A
PhasesNlyte.Model.PowerTypeEnumtruefalse false N/AN/AN/AN/AN/A
PowerFactorEdm.Decimaltruefalse false N/A0143
RatedAmpsEdm.Int32truefalse false N/AN/AN/AN/AN/A
StartingNumberEdm.Int32falsetrue false N/AN/AN/AN/AN/A
StartingPositionEdm.Int32falsetrue false N/AN/AN/AN/AN/A
VoltsL2LNlyte.Model.VoltsL2LEnumtruefalse false N/AN/AN/AN/AN/A

BreakerPanel Navigational Properties

PropertyType
BreakersCollection(Nlyte.Model.Breaker)
PDUNlyte.Model.PDU



BusBarPDUMaterial Entity : PDUMaterial

Verb(s)Required Permission(s)LinkDescription
GetWS-ReadPDUMaterialintegration/api/odata/BusBarPDUMaterials, integration/api/odata/BusBarPDUMaterials({key})
PostWS-AddPDUMaterialintegration/api/odata/BusBarPDUMaterials
PostWithKeyWS-ModifyPDUMaterial
PatchWS-ModifyPDUMaterialintegration/api/odata/BusBarPDUMaterials({key})
DeleteWS-ModifyPDUMaterialintegration/api/odata/BusBarPDUMaterials({key})

Key(s)
MaterialID

BusBarPDUMaterial Structural Properties

No structural properties

BusBarPDUMaterial Navigational Properties

No navigational properties


BusinessApplication Entity - Entity representing a business application

Verb(s)Required Permission(s)LinkDescription
GetWS-ReadBusinessApplicationintegration/api/odata/BusinessApplications, integration/api/odata/BusinessApplications({key})
PatchWS-ModifyBusinessApplicationintegration/api/odata/BusinessApplications({key})
DeleteWS-ModifyBusinessApplicationintegration/api/odata/BusinessApplications({key})
PostWS-AddBusinessApplicationintegration/api/odata/BusinessApplications
PostWithKeyWS-ModifyBusinessApplicationintegration/api/odata/BusinessApplications({key})

Key(s)
BusinessApplicationID

BusinessApplication Structural Properties

PropertyTypeNullableMandatoryRead-OnlyString lengthMin ValueMax ValuePrecisionMax Dec PlacesIs Only DateDescription
ApplicationManagerResourceIDEdm.Int32truefalse true N/AN/AN/AN/AN/AThe resource id identifying the resource acting as manager for the business application.
BusinessApplicationIDEdm.Int32falsefalse true N/AN/AN/AN/AN/APrimary key
BusinessApplicationLifecycleStatusIDEdm.Int32truetrue false N/AN/AN/AN/AN/ALife-cycle status id, property defined in the administration areas
BusinessApplicationNameEdm.Stringfalsetrue false 255N/AN/AN/AN/A
BusinessApplicationNumberEdm.Int32truefalse true N/AN/AN/AN/AN/A
BusinessApplicationStrategyDateEdm.DateTimeOffsettruefalse true N/AN/AN/AN/AN/A
BusinessApplicationStrategyIDEdm.Int32truetrue false N/AN/AN/AN/AN/AStrategy defined in the administration areas, for business applications.
BusinessCriticalityIDEdm.Int32truetrue false N/AN/AN/AN/AN/ACriticality id, property defined in the administration areas, for business applications.
CreationDateEdm.DateTimeOffsettruefalse true N/AN/AN/AN/AN/AIsOnlyDate
DataConfidentialityIDEdm.Int32truetrue false N/AN/AN/AN/AN/AConfidentiality id, property defined in the administration areas, for business applications.
DataRecoveryIDEdm.Int32truefalse false N/AN/AN/AN/AN/AData recovery id, property defined in the administration areas, for business applications.
DescriptionEdm.Stringtruefalse false 1000N/AN/AN/AN/A
ProductionDateEdm.DateTimeOffsettruefalse true N/AN/AN/AN/AN/AIsOnlyDate
RecordStatusNlyte.Model.BusinessApplicationRecordStatusfalsefalse true N/AN/AN/AN/AN/AReflects the real status of the entity as is in the data-center Canceled or Active.
SoftwareIDEdm.Int32truetrue false N/AN/AN/AN/AN/AThe software Id used as business application parent

BusinessApplication Navigational Properties

PropertyType
BusinessApplicationLifecycleStatusNlyte.Model.BusinessApplicationLifecycleStatus
BusinessApplicationStrategyNlyte.Model.BusinessApplicationStrategy
BusinessCriticalityNlyte.Model.BusinessCriticality
DataConfidentialityNlyte.Model.DataConfidentiality
DataRecoveryNlyte.Model.DataRecovery
HostsCollection(Nlyte.Model.BusinessApplicationServerHostMap)
OwnershipCollection(Nlyte.Model.BusinessApplicationBusinessGroupMap)
ResourceNlyte.Model.Resource
SoftwareNlyte.Model.Software
SupportCollection(Nlyte.Model.BusinessApplicationSupportGroupMap)



BusinessApplicationBusinessGroupMap Entity - Entity representing the association between a business application and a business group

Verb(s)Required Permission(s)LinkDescription
GetWS-ReadBusinessApplicationBusinessGroupMap
PatchWS-ModifyBusinessApplicationBusinessGroupMap
DeleteWS-ModifyBusinessApplicationBusinessGroupMap
PostWS-AddBusinessApplicationBusinessGroupMap
PostWithKeyWS-ModifyBusinessApplicationBusinessGroupMap

Key(s)
ID

BusinessApplicationBusinessGroupMap Structural Properties

PropertyTypeNullableMandatoryRead-OnlyString lengthMin ValueMax ValuePrecisionMax Dec PlacesIs Only DateDescription
BusinessGroupIDEdm.Int32truefalse false N/AN/AN/AN/AN/A
BusinessGroupNameEdm.Stringtruefalse false 255N/AN/AN/AN/A
BusinessGroupNumberEdm.Int32truefalse false N/AN/AN/AN/AN/A
ColourIndexEdm.Int32truefalse false N/AN/AN/AN/AN/A
CultureIDEdm.Int32truefalse false N/AN/AN/AN/AN/A
DescriptionEdm.Stringtruefalse false 255N/AN/AN/AN/A
EmailAddressEdm.Stringtruefalse false 254N/AN/AN/AN/A
IDEdm.Int32falsefalse false N/AN/AN/AN/AN/A
OwnershipPercentageEdm.Bytefalsefalse false N/AN/AN/AN/AN/A
ParentBusinessGroupIDEdm.Int32truefalse false N/AN/AN/AN/AN/A
RecordStatusEdm.Int32falsefalse false N/AN/AN/AN/AN/AReflects the real status of the entity as is in the data-center Canceled or Active.
TelephoneNumberEdm.Stringtruefalse false 30N/AN/AN/AN/A

BusinessApplicationBusinessGroupMap Navigational Properties

PropertyType
BusinessGroupNlyte.Model.BusinessGroup
CultureNlyte.Model.Culture
ParentNlyte.Model.BusinessGroup



BusinessApplicationLifecycleStatus Entity

Verb(s)Required Permission(s)LinkDescription

Key(s)
BusinessApplicationLifecycleStatusID

BusinessApplicationLifecycleStatus Structural Properties

PropertyTypeNullableMandatoryRead-OnlyString lengthMin ValueMax ValuePrecisionMax Dec PlacesIs Only DateDescription
BusinessApplicationLifecycleStatusIDEdm.Int32falsefalse false N/AN/AN/AN/AN/A
DetailEdm.Stringfalsetrue false 30N/AN/AN/AN/ABusiness Application Lifecycle Status

BusinessApplicationLifecycleStatus Navigational Properties

No navigational properties


BusinessApplicationPickerControl Entity : FormControl

Verb(s)Required Permission(s)LinkDescription

Key(s)
ID

BusinessApplicationPickerControl Structural Properties

PropertyTypeNullableMandatoryRead-OnlyString lengthMin ValueMax ValuePrecisionMax Dec PlacesIs Only DateDescription
RowSpanEdm.Int32falsetrue false N/AN/AN/AN/AN/A
TotalTextEdm.Stringtruefalse false N/AN/AN/AN/AN/A

BusinessApplicationPickerControl Navigational Properties

No navigational properties


BusinessApplicationPickerControlValue Entity : FormInstanceControlValue

Verb(s)Required Permission(s)LinkDescription

Key(s)
ID

BusinessApplicationPickerControlValue Structural Properties

No structural properties

BusinessApplicationPickerControlValue Navigational Properties

No navigational properties


BusinessApplicationServerHostMap Entity - Entity representing the association between a business application and a host

Verb(s)Required Permission(s)LinkDescription
GetWS-ReadBusinessApplication
PatchWS-ModifyBusinessApplication
DeleteWS-ModifyBusinessApplication
PostWS-AddBusinessApplication
PostWithKeyWS-ModifyBusinessApplication

Key(s)
BASHPID

BusinessApplicationServerHostMap Structural Properties

PropertyTypeNullableMandatoryRead-OnlyString lengthMin ValueMax ValuePrecisionMax Dec PlacesIs Only DateDescription
ApplicationManagerResourceIDEdm.Int32truefalse false N/AN/AN/AN/AN/A
BASHPIDEdm.Int32falsefalse false N/AN/AN/AN/AN/A
BusinessApplicationIDEdm.Int32truefalse false N/AN/AN/AN/AN/A
BusinessApplicationLifecycleStatusIDEdm.Int32truefalse false N/AN/AN/AN/AN/ALife-cycle status id, property defined in the administration areas
BusinessApplicationNameEdm.Stringtruefalse false 255N/AN/AN/AN/A
BusinessApplicationNumberEdm.Int32truefalse false N/AN/AN/AN/AN/A
BusinessApplicationStrategyDateEdm.DateTimeOffsettruefalse false N/AN/AN/AN/AN/AIsOnlyDate
BusinessApplicationStrategyIDEdm.Int32truefalse false N/AN/AN/AN/AN/AStrategy defined in the administration areas, for business applications.
BusinessCriticalityIDEdm.Int32truefalse false N/AN/AN/AN/AN/ACriticality id, property defined in the administration areas, for business applications.
CreationDateEdm.DateTimeOffsettruefalse false N/AN/AN/AN/AN/A
DataConfidentialityIDEdm.Int32truefalse false N/AN/AN/AN/AN/AConfidentiality id, property defined in the administration areas, for business applications.
DataRecoveryIDEdm.Int32truefalse false N/AN/AN/AN/AN/AData recovery id, property defined in the administration areas, for business applications.
DescriptionEdm.Stringtruefalse false 1000N/AN/AN/AN/A
OwnershipPercentageEdm.Int32truefalse false N/AN/AN/AN/AN/A
ProductionDateEdm.DateTimeOffsettruefalse false N/AN/AN/AN/AN/AIsOnlyDate
RecordStatusNlyte.Model.BusinessApplicationRecordStatusfalsefalse false N/AN/AN/AN/AN/AReflects the real status of the entity as is in the data-center Canceled or Active.
ServerHostIDEdm.Int32truefalse false N/AN/AN/AN/AN/A
SoftwareIDEdm.Int32truefalse false N/AN/AN/AN/AN/A

BusinessApplicationServerHostMap Navigational Properties

PropertyType
BusinessApplicationNlyte.Model.BusinessApplication
BusinessApplicationLifecycleStatusNlyte.Model.BusinessApplicationLifecycleStatus
BusinessApplicationStrategyNlyte.Model.BusinessApplicationStrategy
BusinessCriticalityNlyte.Model.BusinessCriticality
DataConfidentialityNlyte.Model.DataConfidentiality
DataRecoveryNlyte.Model.DataRecovery
ResourceNlyte.Model.Resource
ServerHostNlyte.Model.ServerHost
SoftwareNlyte.Model.Software



BusinessApplicationStrategy Entity

Verb(s)Required Permission(s)LinkDescription

Key(s)
BusinessApplicationStrategyID

BusinessApplicationStrategy Structural Properties

PropertyTypeNullableMandatoryRead-OnlyString lengthMin ValueMax ValuePrecisionMax Dec PlacesIs Only DateDescription
BusinessApplicationStrategyIDEdm.Int32falsefalse false N/AN/AN/AN/AN/A
DetailEdm.Stringfalsetrue false 30N/AN/AN/AN/A

BusinessApplicationStrategy Navigational Properties

No navigational properties


BusinessApplicationSupportGroupMap Entity - Entity representing the association between a business application and a support group

Verb(s)Required Permission(s)LinkDescription
GetWS-ReadBusinessApplicationSupportGroupMap
PatchWS-ModifyBusinessApplicationSupportGroupMap
DeleteWS-ModifyBusinessApplicationSupportGroupMap
PostWS-AddBusinessApplicationSupportGroupMap
PostWithKeyWS-ModifyBusinessApplicationSupportGroupMap

Key(s)
ID

BusinessApplicationSupportGroupMap Structural Properties

PropertyTypeNullableMandatoryRead-OnlyString lengthMin ValueMax ValuePrecisionMax Dec PlacesIs Only DateDescription
ColourIndexEdm.Int32truefalse false N/AN/AN/AN/AN/A
CultureIDEdm.Int32truefalse false N/AN/AN/AN/AN/A
DescriptionEdm.Stringtruefalse false 255N/AN/AN/AN/A
EmailAddressEdm.Stringtruefalse false 254N/AN/AN/AN/A
IDEdm.Int32falsefalse false N/AN/AN/AN/AN/A
ParentSupportGroupIDEdm.Int32truefalse false N/AN/AN/AN/AN/A
RecordStatusEdm.Int32falsefalse false N/AN/AN/AN/AN/AReflects the real status of the entity as is in the data-center Canceled or Active.
SupportGroupIDEdm.Int32truefalse false N/AN/AN/AN/AN/A
SupportGroupNameEdm.Stringtruefalse false 255N/AN/AN/AN/A
SupportGroupNumberEdm.Int32truefalse false N/AN/AN/AN/AN/A
SupportPercentageEdm.Bytefalsefalse false N/AN/AN/AN/AN/A
TelephoneNumberEdm.Stringtruefalse false 30N/AN/AN/AN/A

BusinessApplicationSupportGroupMap Navigational Properties

PropertyType
CultureNlyte.Model.Culture
ParentNlyte.Model.SupportGroup
SupportGroupNlyte.Model.SupportGroup



BusinessCriticality Entity

Verb(s)Required Permission(s)LinkDescription

Key(s)
BusinessCriticalityID

BusinessCriticality Structural Properties

PropertyTypeNullableMandatoryRead-OnlyString lengthMin ValueMax ValuePrecisionMax Dec PlacesIs Only DateDescription
BusinessCriticalityIDEdm.Int32falsefalse false N/AN/AN/AN/AN/A
DetailEdm.Stringfalsetrue false 30N/AN/AN/AN/A

BusinessCriticality Navigational Properties

No navigational properties


BusinessGroup Entity - Entity representing a group of type business group

Verb(s)Required Permission(s)LinkDescription
GetWS-ReadBusinessGroupintegration/api/odata/BusinessGroups, integration/api/odata/BusinessGroups({key})
PatchWS-ModifyBusinessGroupintegration/api/odata/BusinessGroups({key})
DeleteWS-ModifyBusinessGroupintegration/api/odata/BusinessGroups({key})
PostWS-AddBusinessGroupintegration/api/odata/BusinessGroups
PostWithKeyWS-ModifyBusinessGroupintegration/api/odata/BusinessGroups({key})

Key(s)
BusinessGroupID

BusinessGroup Structural Properties

PropertyTypeNullableMandatoryRead-OnlyString lengthMin ValueMax ValuePrecisionMax Dec PlacesIs Only DateDescription
AssigneeIDEdm.Int32falsefalse true N/AN/AN/AN/AN/A
BusinessGroupIDEdm.Int32truefalse true N/AN/AN/AN/AN/A
BusinessGroupNameEdm.Stringfalsetrue false 255N/AN/AN/AN/A
BusinessGroupNumberEdm.Int32truefalse true N/AN/AN/AN/AN/A
DescriptionEdm.Stringtruefalse false 255N/AN/AN/AN/A
EmailAddressEdm.Stringtruefalse false 254N/AN/AN/AN/A
HasChildrenEdm.Booleanfalsefalse true N/AN/AN/AN/AN/A
ParentBusinessGroupIDEdm.Int32falsetrue true N/AN/AN/AN/AN/A
RecordStatusNlyte.Model.OrganisationGroupRecordStatusfalsefalse true N/AN/AN/AN/AN/AReflects the real status of the group as is in the data-center Canceled or Active.
TelephoneNumberEdm.Stringtruefalse false 30N/AN/AN/AN/A

BusinessGroup Navigational Properties

PropertyType
AssociatedBusinessGroupsCollection(Nlyte.Model.BusinessGroup)
BusinessGroupContactsCollection(Nlyte.Model.BusinessGroupResourceMap)
NotesCollection(Nlyte.Model.BusinessGroupNote)
ParentBusinessGroupNlyte.Model.BusinessGroup



BusinessGroupAssetMap Entity - Entity representing the mapping between an asset and a group

Verb(s)Required Permission(s)LinkDescription
GetWS-ReadBusinessGroupAssetMap
PatchWS-ModifyBusinessGroupAssetMap
DeleteWS-ModifyBusinessGroupAssetMap
PostWS-AddBusinessGroupAssetMap
PostWithKeyWS-ModifyBusinessGroupAssetMap

Key(s)
ID

BusinessGroupAssetMap Structural Properties

PropertyTypeNullableMandatoryRead-OnlyString lengthMin ValueMax ValuePrecisionMax Dec PlacesIs Only DateDescription
BusinessGroupIDEdm.Int32truefalse false N/AN/AN/AN/AN/A
BusinessGroupNameEdm.Stringtruefalse false 255N/AN/AN/AN/A
BusinessGroupNumberEdm.Int32truefalse false N/AN/AN/AN/AN/A
ColourIndexEdm.Int32truefalse false N/AN/AN/AN/AN/A
CultureIDEdm.Int32truefalse false N/AN/AN/AN/AN/A
DescriptionEdm.Stringtruefalse false 255N/AN/AN/AN/A
EmailAddressEdm.Stringtruefalse false 254N/AN/AN/AN/A
IDEdm.Int32falsefalse false N/AN/AN/AN/AN/A
OwnershipPercentageEdm.Bytefalsefalse false N/AN/AN/AN/AN/A
ParentBusinessGroupIDEdm.Int32truefalse false N/AN/AN/AN/AN/A
RecordStatusEdm.Int32falsefalse false N/AN/AN/AN/AN/A
TelephoneNumberEdm.Stringtruefalse false 30N/AN/AN/AN/A

BusinessGroupAssetMap Navigational Properties

PropertyType
BusinessGroupNlyte.Model.BusinessGroup
CultureNlyte.Model.Culture
ParentNlyte.Model.BusinessGroup



BusinessGroupNote Entity : Note

Verb(s)Required Permission(s)LinkDescription
PostWS-AddNote
PatchWS-ModifyNote
DeleteWS-ModifyNote
GetWS-ReadNote

Key(s)
NoteID

BusinessGroupNote Structural Properties

No structural properties

BusinessGroupNote Navigational Properties

No navigational properties


BusinessGroupResourceMap Entity

Verb(s)Required Permission(s)LinkDescription
GetWS-ReadBusinessGroupResourceMap
PatchWS-ModifyBusinessGroupResourceMap
DeleteWS-ModifyBusinessGroupResourceMap
PostWS-AddBusinessGroupResourceMap

Key(s)
BusinessGroupResourceMapID

BusinessGroupResourceMap Structural Properties

PropertyTypeNullableMandatoryRead-OnlyString lengthMin ValueMax ValuePrecisionMax Dec PlacesIs Only DateDescription
BusinessGroupIDEdm.Int32truefalse false N/AN/AN/AN/AN/A
BusinessGroupResourceMapIDEdm.Int32falsefalse false N/AN/AN/AN/AN/A
ClientUserGUIDEdm.Stringtruefalse true 100N/AN/AN/AN/A
CompanyEdm.Stringtruefalse true 50N/AN/AN/AN/A
CompanyPhoneNumberEdm.Stringtruefalse true 50N/AN/AN/AN/A
CultureIDEdm.Int32truefalse true N/AN/AN/AN/AN/A
DepartmentEdm.Stringtruefalse true 50N/AN/AN/AN/A
DepartmentPhoneNumberEdm.Stringtruefalse true 50N/AN/AN/AN/A
EmailEdm.Stringtruefalse true 254N/AN/AN/AN/A
ForenameEdm.Stringtruefalse true 50N/AN/AN/AN/A
ManagerResourceIDEdm.Int32truefalse true N/AN/AN/AN/AN/A
MeasurementSystemIDEdm.Int32truefalse true N/AN/AN/AN/AN/A
MiddlenameEdm.Stringtruefalse true 50N/AN/AN/AN/A
MobileNumberEdm.Stringtruefalse true 50N/AN/AN/AN/A
PhoneNumberEdm.Stringtruefalse true 50N/AN/AN/AN/A
PriorityEdm.Int32falsefalse false N/AN/AN/AN/AN/A
ResourceIDEdm.Int32truefalse false N/AN/AN/AN/AN/A
RFIDCardIDEdm.Stringtruefalse true 50N/AN/AN/AN/A
SurnameEdm.Stringtruefalse true 50N/AN/AN/AN/A
TimeZoneEdm.Doubletruefalse true N/AN/AN/AN/AN/A
TitleEdm.Stringtruefalse true 10N/AN/AN/AN/A

BusinessGroupResourceMap Navigational Properties

PropertyType
BusinessGroupNlyte.Model.BusinessGroup
CultureNlyte.Model.Culture
MeasurementSystemNlyte.Model.MeasurementSystem
ParentNlyte.Model.Resource
ResourceNlyte.Model.Resource



Cabinet Entity : Asset - Asset created from a material of type cabinet, entity inheriting the Nlyte.Model.Asset entity

Verb(s)Required Permission(s)LinkDescription
GetWS-ReadCabinetintegration/api/odata/Cabinets, integration/api/odata/Cabinets({key})
PostWS-AddCabinetintegration/api/odata/Cabinets
PatchWS-ModifyCabinetintegration/api/odata/Cabinets({key})
PostWithKeyWS-ModifyCabinetintegration/api/odata/Cabinets({key})
DeleteWS-ModifyCabinetintegration/api/odata/Cabinets({key})

Key(s)
AssetID

Cabinet Structural Properties

PropertyTypeNullableMandatoryRead-OnlyString lengthMin ValueMax ValuePrecisionMax Dec PlacesIs Only DateDescription
AuditDateEdm.DateTimeOffsettruefalse false N/AN/AN/AN/AN/A
AuditStatusCorrectEdm.Booleantruefalse false N/AN/AN/AN/AN/A
CabinetUOrderNlyte.Model.CabinetUOrderEnumfalse false
CabinetUsageIDEdm.Int32truetrue false N/AN/AN/AN/AN/A
CanBeAllocatedToEdm.Booleanfalsefalse false N/AN/AN/AN/AN/AEditable value, if true, the cabinet is being used in auto-allocation process
ContiguousUSpaceEdm.Stringtruefalse true 255N/AN/AN/AN/AA comma separated list of free Us
HeatingLimitEdm.Doublefalsefalse false N/AN/AN/AN/AN/A
HeatThresholdEdm.Doublefalsefalse false N/AN/AN/AN/AN/A
KeyNumberEdm.Stringtruefalse false 15N/AN/AN/AN/A
LastAuditorAccountIDEdm.Int32truefalse false N/AN/AN/AN/AN/A
LockNumberEdm.Stringtruefalse false 15N/AN/AN/AN/A
MaxFreeUSpaceEdm.Int32truefalse false N/AN/AN/AN/AN/AThe maximum number of free Us
TotalPlugsEdm.Int32falsefalse true N/AN/AN/AN/AN/A
WeightLimitEdm.Doubletruefalse false N/A099999999999999.9999184
WeightMaximumEdm.Doubletruefalse false N/A099999999999999.9999184
WeightThresholdEdm.Doubletruefalse false N/A099999999999999.9999184

Cabinet Navigational Properties

PropertyType
CabinetAssetsCollection(Nlyte.Model.Asset)
CabinetMaterialNlyte.Model.CabinetMaterial
CabinetUsCollection(Nlyte.Model.CabinetU)
CabinetUsageNlyte.Model.CabinetUsage
ConsumerCabinetsCollection(Nlyte.Model.CabinetResourceMap)
InputConnectorsCollection(Nlyte.Model.InputConnector)
KVMSwitchesCollection(Nlyte.Model.KVMSwitchCabinetMap)
MarkersCollection(Nlyte.Model.CabinetMarker)
ProviderCabinetsCollection(Nlyte.Model.CabinetResourceMap)
ShelvesCollection(Nlyte.Model.Shelf)
SubnetsCollection(Nlyte.Model.Subnet)



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)LinkDescription

Key(s)
MountedAssetID

CabinetAssetMounting Structural Properties

PropertyTypeNullableMandatoryRead-OnlyString lengthMin ValueMax ValuePrecisionMax Dec PlacesIs Only DateDescription
CabinetUNumberEdm.Int32falsefalse true N/AN/AN/AN/AN/AThe start U position in which the asset is mounted.
LowerCabinetUEdm.Int32falsefalse true N/AN/AN/AN/AN/AThe bottom U position in which the asset is mounted.
PlacementIDNlyte.Model.MountingPlacementfalsefalse true N/AN/AN/AN/AN/ARepresents the mounting position
UDisplayLabelEdm.Int32falsefalse true N/AN/AN/AN/AN/AThe U label to be displayed, representing the top or the bottom U position, depending on the admin parameter

CabinetAssetMounting Navigational Properties

No navigational properties


CabinetMarker Entity - Entity representing the association between a marker mounted a cabinet

Verb(s)Required Permission(s)LinkDescription
GetWS-ReadMarkerintegration/api/odata/CabinetMarkers, integration/api/odata/CabinetMarkers({key})
PostWS-AddMarkerintegration/api/odata/CabinetMarkers
PatchWS-ModifyMarkerintegration/api/odata/CabinetMarkers({key})
PostWithKeyWS-ModifyMarker

Key(s)
CabinetMarkerID

CabinetMarker Structural Properties

PropertyTypeNullableMandatoryRead-OnlyString lengthMin ValueMax ValuePrecisionMax Dec PlacesIs Only DateDescription
AllowCollisionsEdm.Booleanfalsefalse false N/AN/AN/AN/AN/A
CabinetAssetIDEdm.Int32falsetrue false N/AN/AN/AN/AN/A
CabinetMarkerIDEdm.Int32falsefalse false N/AN/AN/AN/AN/A
CabinetMarkerNameEdm.Stringtruefalse false 100N/AN/AN/AN/A
CabinetUNumberEdm.Int32truefalse true N/AN/AN/AN/AN/AThe U on which the asset is mounted
ColorEdm.Stringtruefalse false 20N/AN/AN/AN/A
DepthEdm.Doublefalsefalse true N/AN/AN/AN/AN/A
HeightEdm.Decimaltruefalse false N/AN/AN/AN/AN/A
LowerCabinetUEdm.Int32truefalse false N/AN/AN/AN/AN/AThe bottom U position in which the asset is mounted.
MountingSideNlyte.Model.MountingSidefalsetrue false N/AN/AN/AN/AN/ARepresents the mounting side, property of the asset that holds the mountable asset.
MountingTypeIDEdm.Int32truefalse true N/AN/AN/AN/AN/A
RotationEdm.Int32falsefalse true N/AN/AN/AN/AN/A
UDisplayLabelEdm.Int32truefalse false N/AN/AN/AN/AN/AThe U label to be displayed, representing the top or the bottom U position, depending on the admin parameter
UMountingIDEdm.Int32truefalse true N/AN/AN/AN/AN/AThe foreign key identifying the entity providing details about the Cabinet U in which an asset is mounted.
WidthEdm.Doublefalsefalse true N/AN/AN/AN/AN/A
XcoordEdm.Doublefalsefalse true N/AN/AN/AN/AN/A
YcoordEdm.Doublefalsefalse true N/AN/AN/AN/AN/A
YOffsetEdm.Doubletruefalse false N/AN/AN/AN/AN/A
ZcoordEdm.Doublefalsefalse true N/AN/AN/AN/AN/A

CabinetMarker Navigational Properties

PropertyType
CabinetNlyte.Model.Cabinet
UMountingNlyte.Model.UMounting



CabinetMaterial Entity : Material - Material type inheriting properties from the base type

Verb(s)Required Permission(s)LinkDescription
GetWS-ReadCabinetMaterialintegration/api/odata/CabinetMaterials, integration/api/odata/CabinetMaterials({key})
PostWS-AddCabinetMaterialintegration/api/odata/CabinetMaterials
PatchWS-ModifyCabinetMaterialintegration/api/odata/CabinetMaterials({key})
PostWithKeyWS-ModifyCabinetMaterialintegration/api/odata/CabinetMaterials({key})
DeleteWS-ModifyCabinetMaterialintegration/api/odata/CabinetMaterials({key})

Key(s)
MaterialID

CabinetMaterial Structural Properties

PropertyTypeNullableMandatoryRead-OnlyString lengthMin ValueMax ValuePrecisionMax Dec PlacesIs Only DateDescription
AirflowTypeIDNlyte.Model.AirflowTypeEnumfalsefalse false N/AN/AN/AN/AN/ASelected air flow, from the available values defined in the administration area
CabinetLockTypeIDNlyte.Model.CabinetLockTypeEnumtruefalse false N/AN/AN/AN/AN/A
FrontDoorTypeIDNlyte.Model.CabinetDoorTypeEnumtruefalse false N/AN/AN/AN/AN/A
InternalMountingRailDepthEdm.Doublefalsefalse false N/A09999.999984
InternalMountingRailHeightEdm.Doublefalsefalse false N/A09999.999984Property connected with the UHeight property. InternalMountingRailHeight = UHeight * 44.45
InternalMountingRailWidthEdm.Doublefalsefalse false N/A09999.999984
ManufacturersMaxWattageEdm.Doubletruefalse false N/A0.001999.99963
MaterialCategoryIDEdm.Int32truefalse false N/AN/AN/AN/AN/A
MountingTypeIDNlyte.Model.MountingTypeEnumfalsefalse false N/AN/AN/AN/AN/A
RearDoorTypeIDNlyte.Model.CabinetDoorTypeEnumtruefalse false N/AN/AN/AN/AN/A
RequiredPlugsEdm.Int32falsetrue false N/AN/AN/AN/AN/AValue inserted by the user, while the material is in Planned status
RequiresDiversePowerEdm.Booleanfalsefalse false N/AN/AN/AN/AN/AValue available to be updated by the user only if RequiredPlugs TotalPlugs
TopPanelIDNlyte.Model.TopPanelEnumtruefalse false N/AN/AN/AN/AN/A
TotalPlugsEdm.Int32falsetrue false N/AN/AN/AN/AN/AValue inserted by the user, while the material is in Planned status
UHeightEdm.Int32falsefalse true N/AN/AN/AN/AN/A
WorkableFootPrintFrontEdm.Doublefalsefalse false N/A0999999999999.9999164
WorkableFootPrintHeightEdm.Doublefalsefalse false N/A0999999999999.9999164
WorkableFootPrintRearEdm.Doublefalsefalse false N/A0999999999999.9999164

CabinetMaterial Navigational Properties

PropertyType
InputConnectorMaterialsCollection(Nlyte.Model.InputConnectorMaterial)



CabinetResourceMap Entity

Verb(s)Required Permission(s)LinkDescription
GetWS-ReadCabinetResourceMap
PostWS-AddCabinetResourceMap
PatchWS-ModifyCabinetResourceMap
PostWithKeyWS-ModifyCabinetResourceMap
DeleteWS-ModifyCabinetResourceMap

Key(s)
CabinetResourceMapID

CabinetResourceMap Structural Properties

PropertyTypeNullableMandatoryRead-OnlyString lengthMin ValueMax ValuePrecisionMax Dec PlacesIs Only DateDescription
CabinetResourceMapIDEdm.Int32falsefalse true N/AN/AN/AN/AN/A
ConnectionTypeIDNlyte.Model.CabinetMapResourceTypefalsetrue false N/AN/AN/AN/AN/A
ConsumerCabinetAssetIDEdm.Int32falsefalse true N/AN/AN/AN/AN/A
ProviderCabinetAssetIDEdm.Int32falsefalse true N/AN/AN/AN/AN/A

CabinetResourceMap Navigational Properties

PropertyType
ConsumerCabinetNlyte.Model.Cabinet
ProviderCabinetNlyte.Model.Cabinet



CabinetU Entity - Entity providing the cabinet U details.

Verb(s)Required Permission(s)LinkDescription

Key(s)
CabinetAssetID
CabinetUNumber

CabinetU Structural Properties

PropertyTypeNullableMandatoryRead-OnlyString lengthMin ValueMax ValuePrecisionMax Dec PlacesIs Only DateDescription
AssetsOnUEdm.Stringtruefalse false 40N/AN/AN/AN/AThe asset ids of the asset mounted on the specified U
CabinetAssetIDEdm.Int32falsefalse false N/AN/AN/AN/AN/AThe cabinet that holds the U
CabinetUNumberEdm.Int32falsefalse false N/AN/AN/AN/AN/AThe U on which the asset is mounted
CabinetUStateNlyte.Model.CabinetUStateEnumfalse false

CabinetU Navigational Properties

PropertyType
CabinetNlyte.Model.Cabinet



CabinetUsage Entity

Verb(s)Required Permission(s)LinkDescription

Key(s)
CabinetUsageID

CabinetUsage Structural Properties

PropertyTypeNullableMandatoryRead-OnlyString lengthMin ValueMax ValuePrecisionMax Dec PlacesIs Only DateDescription
CabinetUsageIDEdm.Int32falsefalse false N/AN/AN/AN/AN/A
ColourIDEdm.Int32truefalse false N/AN/AN/AN/AN/A
DetailEdm.Stringfalsetrue false 30N/AN/AN/AN/ACabinet usage description

CabinetUsage Navigational Properties

No navigational properties


Cable Entity

Verb(s)Required Permission(s)LinkDescription
GetWS-ReadNetworkConnection,WS-ReadAssetToAssetMappingintegration/api/odata/Connections, integration/api/odata/Connections({key})

Key(s)
CableID
CableTypeID

Cable Structural Properties

PropertyTypeNullableMandatoryRead-OnlyString lengthMin ValueMax ValuePrecisionMax Dec PlacesIs Only DateDescription
CableColourIDEdm.Int32truefalse false N/AN/AN/AN/AN/A
CableIDEdm.Int32falsefalse false N/AN/AN/AN/AN/A
CableLengthEdm.Decimaltruefalse false N/AN/AN/AN/AN/A
CableNameEdm.Stringtruefalse false N/AN/AN/AN/AN/A
CableTypeIDEdm.Int32falsefalse false N/AN/AN/AN/AN/A
DestinationAssetIDEdm.Int32falsefalse false N/AN/AN/AN/AN/A
DestinationAssetNameEdm.Stringtruefalse false N/AN/AN/AN/AN/A
DestinationAssetNumberEdm.Int32falsefalse false N/AN/AN/AN/AN/A
DestinationCabinetIDEdm.Int32truefalse false N/AN/AN/AN/AN/A
DestinationCabinetNameEdm.Stringtruefalse false N/AN/AN/AN/AN/A
DestinationLocationIDEdm.Int32falsefalse false N/AN/AN/AN/AN/A
DestinationLocationNameEdm.Stringtruefalse false N/AN/AN/AN/AN/A
DestinationPortGroupNameEdm.Stringtruefalse false N/AN/AN/AN/AN/A
DestinationPortGroupTypeEdm.Stringtruefalse false N/AN/AN/AN/AN/A
DestinationPortIDEdm.Int32truefalse false N/AN/AN/AN/AN/A
DestinationPortNameEdm.Stringtruefalse false N/AN/AN/AN/AN/A
SourceAssetIDEdm.Int32falsefalse false N/AN/AN/AN/AN/A
SourceAssetNameEdm.Stringtruefalse false N/AN/AN/AN/AN/A
SourceAssetNumberEdm.Int32falsefalse false N/AN/AN/AN/AN/A
SourceCabinetIDEdm.Int32truefalse false N/AN/AN/AN/AN/A
SourceCabinetNameEdm.Stringtruefalse false N/AN/AN/AN/AN/A
SourceLocationIDEdm.Int32falsefalse false N/AN/AN/AN/AN/A
SourceLocationNameEdm.Stringtruefalse false N/AN/AN/AN/AN/A
SourcePortGroupNameEdm.Stringtruefalse false N/AN/AN/AN/AN/A
SourcePortGroupTypeEdm.Stringtruefalse false N/AN/AN/AN/AN/A
SourcePortIDEdm.Int32truefalse false N/AN/AN/AN/AN/A
SourcePortNameEdm.Stringtruefalse false N/AN/AN/AN/AN/A

Cable Navigational Properties

No navigational properties


CableConnection Entity

Verb(s)Required Permission(s)LinkDescription

Key(s)
GraphID

CableConnection Structural Properties

PropertyTypeNullableMandatoryRead-OnlyString lengthMin ValueMax ValuePrecisionMax Dec PlacesIs Only DateDescription
CableColourIDEdm.Int32truefalse false N/AN/AN/AN/AN/A
CableLengthEdm.Decimaltruefalse false N/AN/AN/AN/AN/A
CableNameEdm.Stringtruefalse false N/AN/AN/AN/AN/A
CableTrunkNameEdm.Stringtruefalse false N/AN/AN/AN/AN/A
CableTypeEdm.Stringtruefalse false N/AN/AN/AN/AN/A
ConnectionTypeNlyte.Model.ConnectionTypeEnumfalsefalse false N/AN/AN/AN/AN/A
CrossSectionalAreaEdm.Decimaltruefalse false N/AN/AN/AN/AN/A
EndAssetIDEdm.Int32falsefalse false N/AN/AN/AN/AN/A
EndCardNameEdm.Stringtruefalse false N/AN/AN/AN/AN/A
EndConnectorNameEdm.Stringtruefalse false N/AN/AN/AN/AN/A
EndConnectorTypeEdm.Stringtruefalse false N/AN/AN/AN/AN/A
EndDataTypeEdm.Int32truefalse false N/AN/AN/AN/AN/A
EndPortGroupIDEdm.Int32truefalse false N/AN/AN/AN/AN/A
EndPortGroupNameEdm.Stringtruefalse false N/AN/AN/AN/AN/A
EndPortGroupTypeEdm.Stringtruefalse false N/AN/AN/AN/AN/A
EndPortIDEdm.Int32truefalse false N/AN/AN/AN/AN/A
EndPortLocationIDNlyte.Model.PortLocationfalsefalse false N/AN/AN/AN/AN/A
EndPortNameEdm.Stringtruefalse false N/AN/AN/AN/AN/A
EndPortStateEdm.Int32truefalse false N/AN/AN/AN/AN/A
EndPortTypeEdm.Int32falsefalse false N/AN/AN/AN/AN/A
EndSpeedEdm.Int32truefalse false N/AN/AN/AN/AN/A
GraphIDEdm.Int32falsefalse false N/AN/AN/AN/AN/A
HostingEndAssetIDEdm.Int32falsefalse false N/AN/AN/AN/AN/A
HostingStartAssetIDEdm.Int32falsefalse false N/AN/AN/AN/AN/A
IsProperPortGroupConnectionEdm.Booleanfalsefalse false N/AN/AN/AN/AN/A
MaxKvaEdm.Decimaltruefalse false N/AN/AN/AN/AN/A
StartAssetIDEdm.Int32falsefalse false N/AN/AN/AN/AN/A
StartCardNameEdm.Stringtruefalse false N/AN/AN/AN/AN/A
StartConnectorNameEdm.Stringtruefalse false N/AN/AN/AN/AN/A
StartConnectorTypeEdm.Stringtruefalse false N/AN/AN/AN/AN/A
StartDataTypeEdm.Int32truefalse false N/AN/AN/AN/AN/A
StartPortGroupIDEdm.Int32truefalse false N/AN/AN/AN/AN/A
StartPortGroupNameEdm.Stringtruefalse false N/AN/AN/AN/AN/A
StartPortGroupTypeEdm.Stringtruefalse false N/AN/AN/AN/AN/A
StartPortIDEdm.Int32truefalse false N/AN/AN/AN/AN/A
StartPortLocationIDNlyte.Model.PortLocationfalsefalse false N/AN/AN/AN/AN/A
StartPortNameEdm.Stringtruefalse false N/AN/AN/AN/AN/A
StartPortStateEdm.Int32truefalse false N/AN/AN/AN/AN/A
StartPortTypeEdm.Int32falsefalse false N/AN/AN/AN/AN/A
StartSpeedEdm.Int32truefalse false N/AN/AN/AN/AN/A

CableConnection Navigational Properties

No navigational properties


CardConnection Entity : NetworkPortConnection

Verb(s)Required Permission(s)LinkDescription

Key(s)
StartNodePortID

CardConnection Structural Properties

PropertyTypeNullableMandatoryRead-OnlyString lengthMin ValueMax ValuePrecisionMax Dec PlacesIs Only DateDescription
StartNodeCardPositionEdm.Stringtruefalse false N/AN/AN/AN/AN/A

CardConnection Navigational Properties

No navigational properties


CardNetworkMaterial Entity : NetworkMaterial

Verb(s)Required Permission(s)LinkDescription
GetWS-ReadNetworkMaterialintegration/api/odata/CardNetworkMaterials, integration/api/odata/CardNetworkMaterials({key})
PostWS-AddNetworkMaterialintegration/api/odata/CardNetworkMaterials
PostWithKeyWS-ModifyNetworkMaterial
PatchWS-ModifyNetworkMaterialintegration/api/odata/CardNetworkMaterials({key})
DeleteWS-ModifyNetworkMaterialintegration/api/odata/CardNetworkMaterials({key})

Key(s)
MaterialID

CardNetworkMaterial Structural Properties

No structural properties

CardNetworkMaterial Navigational Properties

No navigational properties


CascadingForm Entity

Verb(s)Required Permission(s)LinkDescription

Key(s)
ID

CascadingForm Structural Properties

PropertyTypeNullableMandatoryRead-OnlyString lengthMin ValueMax ValuePrecisionMax Dec PlacesIs Only DateDescription
FormIDEdm.Int32truetrue false N/AN/AN/AN/AN/A
IDEdm.Int32falsetrue false N/AN/AN/AN/AN/A
OverridedFormNameEdm.Stringfalsetrue false 250N/AN/AN/AN/A

CascadingForm Navigational Properties

PropertyType
FormNlyte.Model.Form
FormControlNlyte.Model.FormControl



CascadingFormControl Entity : FormControl

Verb(s)Required Permission(s)LinkDescription

Key(s)
ID

CascadingFormControl Structural Properties

No structural properties

CascadingFormControl Navigational Properties

No navigational properties


CascadingFormControlValue Entity : FormInstanceControlValue

Verb(s)Required Permission(s)LinkDescription

Key(s)
ID

CascadingFormControlValue Structural Properties

No structural properties

CascadingFormControlValue Navigational Properties

No navigational properties


CatalogType Entity

Verb(s)Required Permission(s)LinkDescription

Key(s)
CatalogTypeID

CatalogType Structural Properties

PropertyTypeNullableMandatoryRead-OnlyString lengthMin ValueMax ValuePrecisionMax Dec PlacesIs Only DateDescription
CatalogTypeIDEdm.Bytefalsefalse false N/AN/AN/AN/AN/A
DescriptionEdm.Stringtruefalse false 20N/AN/AN/AN/A

CatalogType Navigational Properties

No navigational properties


CeilingMaterial Entity

Verb(s)Required Permission(s)LinkDescription
GetWS-ReadFloorPlanintegration/api/odata/CeilingMaterials, integration/api/odata/CeilingMaterials({key})
PatchWS-ModifyFloorPlan
PutWS-ModifyFloorPlan
PostWS-ModifyFloorPlan

Key(s)
ID

CeilingMaterial Structural Properties

PropertyTypeNullableMandatoryRead-OnlyString lengthMin ValueMax ValuePrecisionMax Dec PlacesIs Only DateDescription
DescriptionEdm.Stringfalsetrue false 50N/AN/AN/AN/A
IDEdm.Int32falsefalse false N/AN/AN/AN/AN/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)LinkDescription
GetWS-ReadChassisintegration/api/odata/Chassis, integration/api/odata/Chassis({key})
PatchWS-ModifyChassisintegration/api/odata/Chassis({key})
DeleteWS-ModifyChassisintegration/api/odata/Chassis({key})
PostWithKeyWS-ModifyChassisintegration/api/odata/Chassis({key})
PostWS-AddChassisintegration/api/odata/Chassis

Key(s)
AssetID

Chassis Structural Properties

PropertyTypeNullableMandatoryRead-OnlyString lengthMin ValueMax ValuePrecisionMax Dec PlacesIs Only DateDescription
AuditDateEdm.DateTimeOffsettruefalse false N/AN/AN/AN/AN/A
AuditStatusCorrectEdm.Booleantruefalse false N/AN/AN/AN/AN/A
CurrentPowerFactorEdm.Decimaltruefalse true N/AN/AN/AN/AN/ARead-only property representing the percentage of power drawn by a PDD asset that is available to its consumers
IsMasterRedundancyDeviceEdm.Booleantruefalse false N/AN/AN/AN/AN/AValue inserted by the user
LastAuditorAccountIDEdm.Int32truefalse false N/AN/AN/AN/AN/A
OutputCountEdm.Int32truefalse true N/AN/AN/AN/AN/A
PowerFactorOverrideEdm.Decimaltruefalse false N/A0132Value provided by the user, overriding the CurrentPowerFactor value
ProjectIDEdm.Int32truefalse false N/AN/AN/AN/AN/AThe project id for the selected project. Projects are defined in the administration area.
RealtimePowerFactorEdm.Decimaltruefalse true N/AN/AN/AN/AN/ARead-only value.
StrategyIDEdm.Int32true false
TotalPlugsEdm.Int32falsefalse true N/AN/AN/AN/AN/A
TotalSystemSpaceEdm.Int32truefalse false N/AN/AN/AN/AN/A
TrancheNumberEdm.Int32truefalse false N/AN/AN/AN/AN/A

Chassis Navigational Properties

PropertyType
ChassisMaterialNlyte.Model.ChassisMaterial
ChassisMountedAssetMapsCollection(Nlyte.Model.ChassisMountedAssetMap)
ChassisSlotsCollection(Nlyte.Model.ChassisSlots)
InputConnectorsCollection(Nlyte.Model.InputConnector)
PeripheralsCollection(Nlyte.Model.PeripheralAssetLink)
PhysicalPartitionsCollection(Nlyte.Model.PhysicalPartition)
ProjectNlyte.Model.ProjectPurpose
ServerHostsCollection(Nlyte.Model.ServerHost)
StrategyNlyte.Model.ProjectAction
UtilitiesCollection(Nlyte.Model.Supplier)
WiresCollection(Nlyte.Model.Wire)



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)LinkDescription

Key(s)
MountedAssetID

ChassisAssetMounting Structural Properties

PropertyTypeNullableMandatoryRead-OnlyString lengthMin ValueMax ValuePrecisionMax Dec PlacesIs Only DateDescription
ColumnPositionEdm.Int32falsefalse true N/AN/AN/AN/AN/AThe starting column in the chassis in which the asset is mounted.
RowPositionEdm.Int32falsefalse true N/AN/AN/AN/AN/AThe starting row in the chassis in which the asset is mounted.

ChassisAssetMounting Navigational Properties

No navigational properties


ChassisMaterial Entity : Material - Material type inheriting properties from the base type

Verb(s)Required Permission(s)LinkDescription
GetWS-ReadChassisMaterialintegration/api/odata/ChassisMaterials, integration/api/odata/ChassisMaterials({key})
PostWS-AddChassisMaterialintegration/api/odata/ChassisMaterials
PostWithKeyWS-ModifyChassisMaterialintegration/api/odata/ChassisMaterials({key})
PatchWS-ModifyChassisMaterialintegration/api/odata/ChassisMaterials({key})
DeleteWS-ModifyChassisMaterialintegration/api/odata/ChassisMaterials({key})

Key(s)
MaterialID

ChassisMaterial Structural Properties

PropertyTypeNullableMandatoryRead-OnlyString lengthMin ValueMax ValuePrecisionMax Dec PlacesIs Only DateDescription
AirflowTypeIDNlyte.Model.AirflowTypeEnumfalsetrue false N/AN/AN/AN/AN/ASelected air flow, from the available values defined in the administration area
CalculatedMaxKWEdm.Decimaltruefalse true N/AN/AN/AN/AN/Aread-only property, provided by the service, calculated based on MaxV
CalculatedMpafPowerConsumptionEdm.Decimaltruefalse true N/AN/AN/AN/AN/ARead-only property, value provided by the service based on the PublishedPowerConsumption and the MpafOverride
ConsumerPowerFactorEdm.Decimalfalsefalse true N/AN/AN/AN/AN/ARead-only property representing the percentage of power drawn by a PDD material that is available to its asset consumers
DistributorPowerFactorEdm.Decimalfalsefalse true N/AN/AN/AN/AN/A
IsSuppliedMaterialUpdatedEdm.Booleanfalsefalse true N/AN/AN/AN/AN/Aread-only property, set to true when a user modifies ChassisMaterialSlots
MaterialCategoryIDEdm.Int32truefalse false N/AN/AN/AN/AN/A
MaxAEdm.Decimaltruefalse false N/A099999.99983
MaxVEdm.Decimaltruefalse false N/A099999.99983
MountingTypeIDNlyte.Model.MountingTypeEnumfalsetrue false N/AN/AN/AN/AN/A
MpafOverrideEdm.Decimaltruefalse false N/A099963Value inserted by the user, while the material is in Planned status
NumberOfColumnsBackEdm.Int32falsefalse false N/AN/AN/AN/AN/AProperty representing the number of columns present in the back of the chassis
NumberOfColumnsFrontEdm.Int32falsefalse false N/AN/AN/AN/AN/AProperty representing the number of columns present in the front of the chassis
NumberOfRowsBackEdm.Int32falsefalse false N/AN/AN/AN/AN/AProperty representing the number of rows present in the back of the chassis
NumberOfRowsFrontEdm.Int32falsefalse false N/AN/AN/AN/AN/AProperty representing the number of rows present in the front of the chassis
PlugTypeEdm.Stringtruefalse false 50N/AN/AN/AN/AProperty selected from the available types, available as lookups InputConnectorTypes
PowerTypeIDNlyte.Model.PowerTypeEnumtruefalse false N/AN/AN/AN/AN/APower type: phased or direct current
PublishedPowerConsumptionEdm.Decimalfalsefalse false N/A099963Value inserted by the user, while the material is in Planned status
RequiredPlugsEdm.Int32falsetrue false N/AN/AN/AN/AN/AValue inserted by the user, while the material is in Planned status
RequiresDiversePowerEdm.Booleanfalsefalse false N/AN/AN/AN/AN/AValue available to be updated by the user only if RequiredPlugs TotalPlugs
TotalPlugsEdm.Int32falsetrue false N/AN/AN/AN/AN/AValue inserted by the user, while the material is in Planned status
UHeightEdm.Int64falsefalse true N/AN/AN/AN/AN/A
WorkableFootPrintFrontEdm.Doublefalsefalse false N/A0999999999999.9999164
WorkableFootPrintHeightEdm.Doublefalsefalse false N/A0999999999999.9999164
WorkableFootPrintRearEdm.Doublefalsefalse false N/A0999999999999.9999164

ChassisMaterial Navigational Properties

PropertyType
ChassisMaterialSlotsCollection(Nlyte.Model.ChassisMaterialSlot)
InputConnectorMaterialsCollection(Nlyte.Model.InputConnectorMaterial)



ChassisMaterialSlot Entity

Verb(s)Required Permission(s)LinkDescription
GetWS-ReadChassisMaterial
PatchWS-ModifyChassisMaterial
PostWithKeyWS-ModifyChassisMaterial

Key(s)
ID

ChassisMaterialSlot Structural Properties

PropertyTypeNullableMandatoryRead-OnlyString lengthMin ValueMax ValuePrecisionMax Dec PlacesIs Only DateDescription
ChassisMaterialIDEdm.Int32falsefalse true N/AN/AN/AN/AN/A
ColumnPositionEdm.Bytefalsefalse true N/AN/AN/AN/AN/A
IDEdm.Int32falsefalse true N/AN/AN/AN/AN/A
MountingSideNlyte.Model.MountingSidefalse false
RowPositionEdm.Bytefalsefalse true N/AN/AN/AN/AN/A
SlotNameEdm.Stringtruetrue false 10N/AN/AN/AN/A

ChassisMaterialSlot Navigational Properties

PropertyType
ChassisMaterialNlyte.Model.ChassisMaterial



ChassisMountedAssetMap Entity - An entity representing details of the mounted asset in a chassis

Verb(s)Required Permission(s)LinkDescription
GetWS-ReadChassisMountedAssetMap
PostWS-AddChassisMountedAssetMap
PatchWS-ModifyChassisMountedAssetMap
PostWithKeyWS-ModifyChassisMountedAssetMap
DeleteWS-ModifyChassisMountedAssetMap

Key(s)
ChassisMountedAssetMapID

ChassisMountedAssetMap Structural Properties

PropertyTypeNullableMandatoryRead-OnlyString lengthMin ValueMax ValuePrecisionMax Dec PlacesIs Only DateDescription
ChassisAssetIDEdm.Int32falsefalse false N/AN/AN/AN/AN/A
ChassisMountedAssetMapIDEdm.Int32falsefalse false N/AN/AN/AN/AN/A
ColumnPositionEdm.Bytefalsefalse false N/AN/AN/AN/AN/A
MountedAssetIDEdm.Int32truefalse false N/AN/AN/AN/AN/A
MountingSideNlyte.Model.MountingSidefalse false
RowPositionEdm.Bytefalsefalse false N/AN/AN/AN/AN/A
SlotNameEdm.Stringtruefalse false N/AN/AN/AN/AN/A

ChassisMountedAssetMap Navigational Properties

PropertyType
ChassisNlyte.Model.Chassis
MountedAssetNlyte.Model.Asset



ChassisSlots Entity - ToDo

Verb(s)Required Permission(s)LinkDescription
GetWS-ReadChassis
PatchWS-ModifyChassis
PostWithKeyWS-ModifyChassis

Key(s)
ID

ChassisSlots Structural Properties

PropertyTypeNullableMandatoryRead-OnlyString lengthMin ValueMax ValuePrecisionMax Dec PlacesIs Only DateDescription
ChassisAssetIDEdm.Int32falsefalse false N/AN/AN/AN/AN/A
ColumnPositionEdm.Bytefalsefalse false N/AN/AN/AN/AN/A
IDEdm.Int32falsefalse false N/AN/AN/AN/AN/A
MountingSideNlyte.Model.MountingSidefalse false
RowPositionEdm.Bytefalsefalse false N/AN/AN/AN/AN/A
SlotNameEdm.Stringtruefalse false 10N/AN/AN/AN/AChassis Slot Name. This must be unique for the same orientation in the same chassis.

ChassisSlots Navigational Properties

PropertyType
ChassisNlyte.Model.Chassis



CheckBoxControl Entity : FormControl

Verb(s)Required Permission(s)LinkDescription

Key(s)
ID

CheckBoxControl Structural Properties

No structural properties

CheckBoxControl Navigational Properties

No navigational properties


CheckBoxControlValue Entity : FormInstanceControlValue

Verb(s)Required Permission(s)LinkDescription

Key(s)
ID

CheckBoxControlValue Structural Properties

No structural properties

CheckBoxControlValue Navigational Properties

No navigational properties


CloudProvider Entity

Verb(s)Required Permission(s)LinkDescription

Key(s)
CloudProviderId

CloudProvider Structural Properties

PropertyTypeNullableMandatoryRead-OnlyString lengthMin ValueMax ValuePrecisionMax Dec PlacesIs Only DateDescription
CloudProviderIdEdm.Int32falsefalse false N/AN/AN/AN/AN/A
DetailEdm.Stringfalsetrue false 250N/AN/AN/AN/ACloud provider description

CloudProvider Navigational Properties

No navigational properties


ComboBoxControl Entity : FormControl

Verb(s)Required Permission(s)LinkDescription

Key(s)
ID

ComboBoxControl Structural Properties

PropertyTypeNullableMandatoryRead-OnlyString lengthMin ValueMax ValuePrecisionMax Dec PlacesIs Only DateDescription
ItemsCollection(Nlyte.Model.ComboBoxControlItem)truefalse false N/AN/AN/AN/AN/A
PredefinedListTypeNlyte.Model.PredefinedListTypetruefalse false N/AN/AN/AN/AN/A
UseIntegrationTagEdm.Booleanfalsetrue false N/AN/AN/AN/AN/A

ComboBoxControl Navigational Properties

No navigational properties


ComboBoxControlValue Entity : FormInstanceControlValue

Verb(s)Required Permission(s)LinkDescription

Key(s)
ID

ComboBoxControlValue Structural Properties

No structural properties

ComboBoxControlValue Navigational Properties

No navigational properties


CompleteActivityControl Entity : FormControl

Verb(s)Required Permission(s)LinkDescription

Key(s)
ID

CompleteActivityControl Structural Properties

No structural properties

CompleteActivityControl Navigational Properties

No navigational properties


CompleteActivityControlValue Entity : FormInstanceControlValue

Verb(s)Required Permission(s)LinkDescription

Key(s)
ID

CompleteActivityControlValue Structural Properties

No structural properties

CompleteActivityControlValue Navigational Properties

No navigational properties


ConsumerDistributorMaterialType Entity : MaterialType

Verb(s)Required Permission(s)LinkDescription

Key(s)
MaterialTypeID

ConsumerDistributorMaterialType Structural Properties

PropertyTypeNullableMandatoryRead-OnlyString lengthMin ValueMax ValuePrecisionMax Dec PlacesIs Only DateDescription
ConsumerPowerFactorEdm.Doublefalsefalse false N/AN/AN/AN/AN/A
DistributorPowerFactorEdm.Decimalfalsefalse false N/AN/AN/AN/AN/A

ConsumerDistributorMaterialType Navigational Properties

No navigational properties


ConsumerMaterial Entity - Power consumer material

Verb(s)Required Permission(s)LinkDescription

Key(s)
MaterialID

ConsumerMaterial Structural Properties

PropertyTypeNullableMandatoryRead-OnlyString lengthMin ValueMax ValuePrecisionMax Dec PlacesIs Only DateDescription
MaterialIDEdm.Int32truefalse false N/AN/AN/AN/AN/A
MpafOverrideEdm.Decimaltruefalse false N/AN/AN/AN/AN/AValue inserted by the user, while the material is in Planned status
PublishedPowerConsumptionEdm.Decimalfalsefalse false N/AN/AN/AN/AN/AValue inserted by the user, while the material is in Planned status
RequiresDiversePowerEdm.Booleanfalsefalse false N/AN/AN/AN/AN/A

ConsumerMaterial Navigational Properties

PropertyType
PowerMaterialNlyte.Model.PowerMaterial



ConsumerMaterialType Entity : MaterialType

Verb(s)Required Permission(s)LinkDescription

Key(s)
MaterialTypeID

ConsumerMaterialType Structural Properties

PropertyTypeNullableMandatoryRead-OnlyString lengthMin ValueMax ValuePrecisionMax Dec PlacesIs Only DateDescription
ConsumerPowerFactorEdm.Doublefalsefalse false N/AN/AN/AN/AN/A
ConsumerPowerFactorEdm.Doublefalse false

ConsumerMaterialType Navigational Properties

No navigational properties


ControlAsset Entity

Verb(s)Required Permission(s)LinkDescription

Key(s)
FormControlID
AssetID

ControlAsset Structural Properties

PropertyTypeNullableMandatoryRead-OnlyString lengthMin ValueMax ValuePrecisionMax Dec PlacesIs Only DateDescription
AssetIDEdm.Int32falsefalse true N/AN/AN/AN/AN/A
AssetNameEdm.Stringtruefalse true N/AN/AN/AN/AN/A
AssetNumberEdm.Int32truefalse true N/AN/AN/AN/AN/A
CabinetAssetIDEdm.Int32truefalse true N/AN/AN/AN/AN/A
CabinetAssetNameEdm.Stringtruefalse true N/AN/AN/AN/AN/A
CabinetUsageEdm.Stringtruefalse true N/AN/AN/AN/AN/A
CabinetUsageIDEdm.Int32truefalse true N/AN/AN/AN/AN/A
CustomFieldNameEdm.Stringtruefalse true N/AN/AN/AN/AN/A
CustomFieldValueCheckBoxEdm.Booleantruefalse true N/AN/AN/AN/AN/A
CustomFieldValueDateEdm.DateTimeOffsettruefalse true N/AN/AN/AN/AN/A
CustomFieldValueLookupEdm.Int32truefalse true N/AN/AN/AN/AN/A
CustomFieldValueStringEdm.Stringtruefalse true N/AN/AN/AN/AN/A
DuplicateLocationGroupNameEdm.Stringtruefalse true N/AN/AN/AN/AN/A
FormControlIDEdm.Int32falsefalse true N/AN/AN/AN/AN/A
GridReferenceEdm.Stringtruefalse true N/AN/AN/AN/AN/A
GridReferenceColumnEdm.Stringtruefalse true N/AN/AN/AN/AN/A
GridReferenceLayerEdm.Stringtruefalse true N/AN/AN/AN/AN/A
GridReferenceRowEdm.Stringtruefalse true N/AN/AN/AN/AN/A
HeatingLimitEdm.Doubletruefalse true N/AN/AN/AN/AN/A
HeatThresholdEdm.Doubletruefalse true N/AN/AN/AN/AN/A
LocationGroupIDEdm.Int32falsefalse true N/AN/AN/AN/AN/A
LocationGroupNameEdm.Stringtruefalse true N/AN/AN/AN/AN/A
MaterialIDEdm.Int32falsefalse true N/AN/AN/AN/AN/A
MaterialNameEdm.Stringtruefalse true N/AN/AN/AN/AN/A
MaterialNumberEdm.Int32falsefalse true N/AN/AN/AN/AN/A
MaterialSubtypeIDEdm.Int32truefalse true N/AN/AN/AN/AN/A
MaterialTypeIDEdm.Int32truefalse true N/AN/AN/AN/AN/A
OperationalStatusNlyte.Model.OperationalStatusEnumfalsefalse true N/AN/AN/AN/AN/A
PONumberEdm.Stringtruefalse true N/AN/AN/AN/AN/A
PRNumberEdm.Stringtruefalse true N/AN/AN/AN/AN/A
RecordStatusNlyte.Model.RecordStatusEnumfalsefalse true N/AN/AN/AN/AN/A
RFIDTagEdm.Stringtruefalse true N/AN/AN/AN/AN/A
SAPAssetNumberEdm.Stringtruefalse true N/AN/AN/AN/AN/A
SerialNumberEdm.Stringtruefalse true N/AN/AN/AN/AN/A
ServiceRequestIDEdm.Int32truefalse true N/AN/AN/AN/AN/A
TagEdm.Stringtruefalse true N/AN/AN/AN/AN/A
TaskInstanceIDEdm.Int32truefalse true N/AN/AN/AN/AN/A
UDisplayLabelEdm.Int32truefalse true N/AN/AN/AN/AN/ACabinet U Display Label

ControlAsset Navigational Properties

No navigational properties


CreateAssetControl Entity : FormControl

Verb(s)Required Permission(s)LinkDescription

Key(s)
ID

CreateAssetControl Structural Properties

PropertyTypeNullableMandatoryRead-OnlyString lengthMin ValueMax ValuePrecisionMax Dec PlacesIs Only DateDescription
MaterialTypeIdNlyte.Model.CreateAssetMaterialTypefalsetrue false N/AN/AN/AN/AN/A

CreateAssetControl Navigational Properties

No navigational properties


CreateAssetControlValue Entity : FormInstanceControlValue

Verb(s)Required Permission(s)LinkDescription

Key(s)
ID

CreateAssetControlValue Structural Properties

PropertyTypeNullableMandatoryRead-OnlyString lengthMin ValueMax ValuePrecisionMax Dec PlacesIs Only DateDescription
AssetIDEdm.Int32truefalse false N/AN/AN/AN/AN/A

CreateAssetControlValue Navigational Properties

No navigational properties


CrossSectionalArea Entity

Verb(s)Required Permission(s)LinkDescription

Key(s)
CrossSectionalAreaID

CrossSectionalArea Structural Properties

PropertyTypeNullableMandatoryRead-OnlyString lengthMin ValueMax ValuePrecisionMax Dec PlacesIs Only DateDescription
CrossSectionalAreaIDEdm.Int32falsefalse false N/AN/AN/AN/AN/A
DescriptionEdm.Decimalfalsefalse false N/AN/AN/AN/AN/A

CrossSectionalArea Navigational Properties

No navigational properties


Culture Entity

Verb(s)Required Permission(s)LinkDescription

Key(s)
ID

Culture Structural Properties

PropertyTypeNullableMandatoryRead-OnlyString lengthMin ValueMax ValuePrecisionMax Dec PlacesIs Only DateDescription
IDEdm.Int32falsefalse false N/AN/AN/AN/AN/A
NameEdm.Stringtruefalse false 50N/AN/AN/AN/A

Culture Navigational Properties

No navigational properties


CustomField Entity - Entity representing the custom field defined in the administration area and the value defined by the user.

Verb(s)Required Permission(s)LinkDescription
GetWS-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
PostWS-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
PatchWS-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
DeleteWS-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

PropertyTypeNullableMandatoryRead-OnlyString lengthMin ValueMax ValuePrecisionMax Dec PlacesIs Only DateDescription
AssetIDEdm.Int32truefalse false N/AN/AN/AN/AN/AAsset for which the custom field value was defined
DataFieldAssetValueIDEdm.Int32falsefalse false N/AN/AN/AN/AN/A
DataLabelEdm.Stringtruefalse false 50N/AN/AN/AN/A
DataValueCheckBoxEdm.Booleantruefalse false N/AN/AN/AN/AN/ADepending on the custom field type, value is provided.
DataValueDateEdm.DateTimeOffsettruefalse false N/AN/AN/AN/AN/AIsOnlyDateDepending on the custom field type, value is provided.
DataValueFieldNameEdm.Stringtruefalse false N/AN/AN/AN/AN/A
DataValueLookupEdm.Int32truefalse false N/AN/AN/AN/AN/ADepending on the custom field type, value is provided.
DataValueStringEdm.Stringtruefalse false 1000N/AN/AN/AN/ADepending on the custom field type, value is provided.

CustomField Navigational Properties

PropertyType
AssetNlyte.Model.Asset



CustomFieldLookupValue Entity - Entity representing the custom field lookup values defined in the administration area.

Verb(s)Required Permission(s)LinkDescription
GetWS-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
PostWS-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
PatchWS-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
DeleteWS-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

PropertyTypeNullableMandatoryRead-OnlyString lengthMin ValueMax ValuePrecisionMax Dec PlacesIs Only DateDescription
ActiveEdm.Booleanfalsefalse false N/AN/AN/AN/AN/A
CustomFieldLookupValueIDEdm.Int32falsefalse false N/AN/AN/AN/AN/A
DataFieldIDEdm.Int32truefalse false N/AN/AN/AN/AN/A
DetailEdm.Stringtruefalse false N/AN/AN/AN/AN/A

CustomFieldLookupValue Navigational Properties

PropertyType
CustomFieldTypeNlyte.Model.CustomFieldType



CustomFieldType Entity

Verb(s)Required Permission(s)LinkDescription

Key(s)
ID

CustomFieldType Structural Properties

PropertyTypeNullableMandatoryRead-OnlyString lengthMin ValueMax ValuePrecisionMax Dec PlacesIs Only DateDescription
AdvancedSearchableEdm.Booleanfalsefalse false N/AN/AN/AN/AN/A
DataTypeEdm.Stringtruefalse false N/AN/AN/AN/AN/A
IDEdm.Int32falsefalse false N/AN/AN/AN/AN/A
ItemOrderEdm.Int32falsefalse false N/AN/AN/AN/AN/A
MaterialTypeEdm.Stringtruefalse false N/AN/AN/AN/AN/A
MaterialTypeIDEdm.Int32falsefalse false N/AN/AN/AN/AN/A
NameEdm.Stringtruefalse false N/AN/AN/AN/AN/A

CustomFieldType Navigational Properties

PropertyType
LookupsCollection(Nlyte.Model.CustomFieldLookupValue)



DataConfidentiality Entity

Verb(s)Required Permission(s)LinkDescription

Key(s)
DataConfidentialityID

DataConfidentiality Structural Properties

PropertyTypeNullableMandatoryRead-OnlyString lengthMin ValueMax ValuePrecisionMax Dec PlacesIs Only DateDescription
DataConfidentialityIDEdm.Int32falsefalse false N/AN/AN/AN/AN/A
DetailEdm.Stringfalsetrue false 30N/AN/AN/AN/AData confidentiality description

DataConfidentiality Navigational Properties

No navigational properties


DataRecovery Entity

Verb(s)Required Permission(s)LinkDescription

Key(s)
DataRecoveryID

DataRecovery Structural Properties

PropertyTypeNullableMandatoryRead-OnlyString lengthMin ValueMax ValuePrecisionMax Dec PlacesIs Only DateDescription
DataRecoveryIDEdm.Int32falsefalse false N/AN/AN/AN/AN/A
DetailEdm.Stringfalsetrue false 30N/AN/AN/AN/AData recovery description

DataRecovery Navigational Properties

No navigational properties


DatePickerControl Entity : FormControl

Verb(s)Required Permission(s)LinkDescription

Key(s)
ID

DatePickerControl Structural Properties

PropertyTypeNullableMandatoryRead-OnlyString lengthMin ValueMax ValuePrecisionMax Dec PlacesIs Only DateDescription
DefaultDateEdm.DateTimeOffsettruefalse false N/AN/AN/AN/AN/AIsOnlyDate
PreventSelectingExcludedDatesEdm.Booleanfalsefalse false N/AN/AN/AN/AN/A

DatePickerControl Navigational Properties

No navigational properties


DatePickerControlValue Entity : FormInstanceControlValue

Verb(s)Required Permission(s)LinkDescription

Key(s)
ID

DatePickerControlValue Structural Properties

No structural properties

DatePickerControlValue Navigational Properties

No navigational properties


DecommissionAssetControl Entity : FormControl

Verb(s)Required Permission(s)LinkDescription

Key(s)
ID

DecommissionAssetControl Structural Properties

No structural properties

DecommissionAssetControl Navigational Properties

No navigational properties


DecommissionAssetControlValue Entity : FormInstanceControlValue

Verb(s)Required Permission(s)LinkDescription

Key(s)
ID

DecommissionAssetControlValue Structural Properties

PropertyTypeNullableMandatoryRead-OnlyString lengthMin ValueMax ValuePrecisionMax Dec PlacesIs Only DateDescription
ProcessedAssetIDsCollection(Edm.Int32)falsefalse false N/AN/AN/AN/AN/A

DecommissionAssetControlValue Navigational Properties

No navigational properties


DisplayProperties Entity

Verb(s)Required Permission(s)LinkDescription
GetWS-ReadRoomPlan
PatchWS-ModifyRoomPlan
PutWS-ModifyRoomPlan
DeleteWS-ModifyRoomPlan
PostWS-ModifyRoomPlan

Key(s)
ID

DisplayProperties Structural Properties

PropertyTypeNullableMandatoryRead-OnlyString lengthMin ValueMax ValuePrecisionMax Dec PlacesIs Only DateDescription
AlphaEdm.Int32falsefalse false N/AN/AN/AN/AN/A
BorderColourEdm.Int32falsefalse false N/AN/AN/AN/AN/A
FillColourEdm.Int32falsefalse false N/AN/AN/AN/AN/A
FontAlignmentEdm.Stringtruetrue false 50N/AN/AN/AN/A
FontBackgroundColourEdm.Int32falsefalse false N/AN/AN/AN/AN/A
FontColourEdm.Int32falsefalse false N/AN/AN/AN/AN/A
FontFamilyEdm.Stringtruetrue false 50N/AN/AN/AN/A
FontSizeEdm.Decimalfalsefalse false N/AN/AN/AN/AN/A
IDEdm.Int32falsefalse false N/AN/AN/AN/AN/A
LineColourEdm.Int32falsefalse false N/AN/AN/AN/AN/A
SaveActionNlyte.Model.SaveActionEnumfalsefalse false N/AN/AN/AN/AN/A

DisplayProperties Navigational Properties

No navigational properties


DistributorMaterial Entity - Power supplier material

Verb(s)Required Permission(s)LinkDescription

Key(s)
MaterialID

DistributorMaterial Structural Properties

PropertyTypeNullableMandatoryRead-OnlyString lengthMin ValueMax ValuePrecisionMax Dec PlacesIs Only DateDescription
DeratingFactorEdm.Decimaltruefalse false N/AN/AN/AN/AN/A
MaterialIDEdm.Int32truefalse false N/AN/AN/AN/AN/A
MaxAEdm.Decimaltruefalse false N/A099999.99983
MaxKVAEdm.Decimaltruefalse false N/A099999999.9999124
MaxKWEdm.Decimaltruefalse false N/A099999999.9999124
MaxVEdm.Decimaltruefalse false N/A099999.99983
OutputCountEdm.Int32falsefalse false N/AN/AN/AN/AN/A
PowerFactorEdm.Decimaltruefalse false N/AN/AN/AN/AN/ARead-only property representing the percentage of power drawn by a PDD material that is available to its asset consumers

DistributorMaterial Navigational Properties

PropertyType
OutputConnectorMaterialsCollection(Nlyte.Model.OutputConnectorMaterial)
PowerMaterialNlyte.Model.PowerMaterial
SupplierMaterialsCollection(Nlyte.Model.SupplierMaterial)



DistributorMaterialType Entity : MaterialType

Verb(s)Required Permission(s)LinkDescription

Key(s)
MaterialTypeID

DistributorMaterialType Structural Properties

PropertyTypeNullableMandatoryRead-OnlyString lengthMin ValueMax ValuePrecisionMax Dec PlacesIs Only DateDescription
DistributorPowerFactorEdm.Decimalfalsefalse false N/AN/AN/AN/AN/A

DistributorMaterialType Navigational Properties

No navigational properties


EditAssetControl Entity : FormControl

Verb(s)Required Permission(s)LinkDescription

Key(s)
ID

EditAssetControl Structural Properties

PropertyTypeNullableMandatoryRead-OnlyString lengthMin ValueMax ValuePrecisionMax Dec PlacesIs Only DateDescription
MaterialTypeIdsCollection(Nlyte.Model.MaterialTypeEnum)falsetrue false N/AN/AN/AN/AN/A

EditAssetControl Navigational Properties

No navigational properties


EditAssetControlValue Entity : FormInstanceControlValue

Verb(s)Required Permission(s)LinkDescription

Key(s)
ID

EditAssetControlValue Structural Properties

No structural properties

EditAssetControlValue Navigational Properties

No navigational properties


EquipmentPickerAsset Entity

Verb(s)Required Permission(s)LinkDescription

Key(s)
ID

EquipmentPickerAsset Structural Properties

PropertyTypeNullableMandatoryRead-OnlyString lengthMin ValueMax ValuePrecisionMax Dec PlacesIs Only DateDescription
AssetIDEdm.Int32truefalse false N/AN/AN/AN/AN/A
EquipmentPickerControlValueIDEdm.Int32truefalse false N/AN/AN/AN/AN/A
IDEdm.Int32falsefalse false N/AN/AN/AN/AN/A
NewAssetNameEdm.Stringtruefalse false N/AN/AN/AN/AN/A
SnapshotEdm.Booleanfalsefalse false N/AN/AN/AN/AN/A
SnapshotValueEdm.Stringtruefalse false 2147483647N/AN/AN/AN/A
WasActionExecutedEdm.Booleanfalsefalse false N/AN/AN/AN/AN/A

EquipmentPickerAsset Navigational Properties

PropertyType
AssetNlyte.Model.Asset
FormInstanceControlValueNlyte.Model.FormInstanceControlValue



EquipmentPickerControl Entity : FormControl

Verb(s)Required Permission(s)LinkDescription

Key(s)
ID

EquipmentPickerControl Structural Properties

PropertyTypeNullableMandatoryRead-OnlyString lengthMin ValueMax ValuePrecisionMax Dec PlacesIs Only DateDescription
AllowMultipleAssetsEdm.Booleanfalsetrue false N/AN/AN/AN/AN/A
MaterialTypeIdsCollection(Nlyte.Model.MaterialTypeEnum)falsetrue false N/AN/AN/AN/AN/A
RowSpanEdm.Int32falsetrue false N/AN/AN/AN/AN/A
TotalTextEdm.Stringtruefalse false N/AN/AN/AN/AN/A

EquipmentPickerControl Navigational Properties

No navigational properties


EquipmentPickerControlValue Entity : FormInstanceControlValue

Verb(s)Required Permission(s)LinkDescription

Key(s)
ID

EquipmentPickerControlValue Structural Properties

No structural properties

EquipmentPickerControlValue Navigational Properties

No navigational properties


ExclusionDate Entity

Verb(s)Required Permission(s)LinkDescription
PostWS-AddExclusionDateintegration/api/odata/ExclusionDates
PatchWS-ModifyExclusionDateintegration/api/odata/ExclusionDates({key})
DeleteWS-ModifyExclusionDateintegration/api/odata/ExclusionDates({key})

Key(s)
ID

ExclusionDate Structural Properties

PropertyTypeNullableMandatoryRead-OnlyString lengthMin ValueMax ValuePrecisionMax Dec PlacesIs Only DateDescription
AssigneeIDEdm.Int32truefalse false N/AN/AN/AN/AN/A
EndDateEdm.DateTimeOffsetfalsefalse false N/AN/AN/AN/AN/AIsOnlyDate
IDEdm.Int32falsefalse true N/AN/AN/AN/AN/A
IsInclusionEdm.Booleanfalsefalse false N/AN/AN/AN/AN/A
NameEdm.Stringfalsetrue false 100N/AN/AN/AN/A
StartDateEdm.DateTimeOffsetfalsefalse false N/AN/AN/AN/AN/AIsOnlyDate

ExclusionDate Navigational Properties

PropertyType
AssigneeNlyte.Model.Assignee



ExtendedRecordListItem Entity : ListItem

Verb(s)Required Permission(s)LinkDescription

Key(s)
ID

ExtendedRecordListItem Structural Properties

PropertyTypeNullableMandatoryRead-OnlyString lengthMin ValueMax ValuePrecisionMax Dec PlacesIs Only DateDescription
ColourIDEdm.Int32truefalse false N/AN/AN/AN/AN/A

ExtendedRecordListItem Navigational Properties

No navigational properties


FieldPickerControl Entity : FormControl

Verb(s)Required Permission(s)LinkDescription

Key(s)
ID

FieldPickerControl Structural Properties

PropertyTypeNullableMandatoryRead-OnlyString lengthMin ValueMax ValuePrecisionMax Dec PlacesIs Only DateDescription
EntityTypeNlyte.Model.FieldPickerEntityTypefalsetrue false N/AN/AN/AN/AN/A
ParameterEdm.Stringtruefalse false N/AN/AN/AN/AN/A

FieldPickerControl Navigational Properties

No navigational properties


FieldPickerControlValue Entity : FormInstanceControlValue

Verb(s)Required Permission(s)LinkDescription

Key(s)
ID

FieldPickerControlValue Structural Properties

No structural properties

FieldPickerControlValue Navigational Properties

No navigational properties


File Entity - Use DownloadFile, UploadFile, DeleteFile to get/add/remove individual files

Verb(s)Required Permission(s)LinkDescription
GetWS-ReadFile
DeleteWS-ModifyFile

Key(s)
Name

File Structural Properties

PropertyTypeNullableMandatoryRead-OnlyString lengthMin ValueMax ValuePrecisionMax Dec PlacesIs Only DateDescription
DateUpdatedEdm.DateTimeOffsettruefalse true N/AN/AN/AN/AN/A
EntityIDEdm.Int32falsefalse true N/AN/AN/AN/AN/A
ExtensionEdm.Stringtruefalse true 10N/AN/AN/AN/A
ModifiedCountEdm.Int32truefalse true N/AN/AN/AN/AN/A
NameEdm.Stringfalsefalse true 200N/AN/AN/AN/A
SizeEdm.Int32truefalse true N/AN/AN/AN/AN/A
UploadedByEdm.Stringtruefalse true 152N/AN/AN/AN/A

File Navigational Properties

No navigational properties


Floor Entity

Verb(s)Required Permission(s)LinkDescription
GetWS-ReadFloorPlanintegration/api/odata/Floors, integration/api/odata/Floors({key})
PatchWS-ModifyFloorPlan
PutWS-ModifyFloorPlanintegration/api/odata/Floors({key})
PostWS-ModifyFloorPlanintegration/api/odata/Floors

Key(s)
ID

Floor Structural Properties

PropertyTypeNullableMandatoryRead-OnlyString lengthMin ValueMax ValuePrecisionMax Dec PlacesIs Only DateDescription
CoolingLimitEdm.Decimaltruefalse false N/A09999999.999103
CoolingMaximumEdm.Decimaltruefalse false N/A09999999.999103
CoolingThresholdEdm.Decimaltruefalse false N/A09999999.999103
HeatLimitEdm.Decimaltruefalse false N/A09999999.999103
HeatMaximumEdm.Decimaltruefalse false N/A09999999.999103
HeatThresholdEdm.Decimaltruefalse false N/A09999999.999103
IDEdm.Int32falsefalse true N/AN/AN/AN/AN/A
LengthEdm.Decimalfalsefalse false N/AN/AN/AN/AN/A
LocationGroupIDEdm.Int32truefalse true N/AN/AN/AN/AN/AForeign key identifying the location
NominalPowerEdm.Decimaltruefalse false N/A09999999.999103
SaveActionNlyte.Model.SaveActionEnumfalsefalse false N/AN/AN/AN/AN/A
WeightLimitEdm.Decimaltruefalse false N/A09999999.9999114
WeightMaximumEdm.Decimaltruefalse false N/A09999999.9999114
WeightThresholdEdm.Decimaltruefalse false N/A09999999.9999114
WidthEdm.Decimalfalsefalse false N/AN/AN/AN/AN/A

Floor Navigational Properties

PropertyType
FloorLayersCollection(Nlyte.Model.FloorLayer)
LocationGroupNlyte.Model.LocationGroup
RoomsCollection(Nlyte.Model.RoomDrawingInfo)
UnplacedRoomsCollection(Nlyte.Model.UnplacedRoom)



FloorLayer Entity : Layer

Verb(s)Required Permission(s)LinkDescription
GetWS-ReadFloorPlan
PatchWS-ModifyFloorPlan
PutWS-ModifyFloorPlan
PostWS-ModifyFloorPlan

Key(s)
ID

FloorLayer Structural Properties

PropertyTypeNullableMandatoryRead-OnlyString lengthMin ValueMax ValuePrecisionMax Dec PlacesIs Only DateDescription
FloorIdEdm.Int32truefalse true N/AN/AN/AN/AN/A

FloorLayer Navigational Properties

PropertyType
FloorNlyte.Model.Floor



FlywheelGeneratorAuxiliaryMaterial Entity : AuxiliaryMaterial

Verb(s)Required Permission(s)LinkDescription
GetWS-ReadAuxiliaryMaterialintegration/api/odata/FlywheelGeneratorAuxiliaryMaterials, integration/api/odata/FlywheelGeneratorAuxiliaryMaterials({key})
PostWS-AddAuxiliaryMaterialintegration/api/odata/FlywheelGeneratorAuxiliaryMaterials
PostWithKeyWS-ModifyAuxiliaryMaterial
PatchWS-ModifyAuxiliaryMaterialintegration/api/odata/FlywheelGeneratorAuxiliaryMaterials({key})
DeleteWS-ModifyAuxiliaryMaterialintegration/api/odata/FlywheelGeneratorAuxiliaryMaterials({key})

Key(s)
MaterialID

FlywheelGeneratorAuxiliaryMaterial Structural Properties

No structural properties

FlywheelGeneratorAuxiliaryMaterial Navigational Properties

No navigational properties


Form Entity

Verb(s)Required Permission(s)LinkDescription
GetWS-ReadFormintegration/api/odata/Forms, integration/api/odata/Forms({key})
PostWS-AddFormintegration/api/odata/Forms
PatchWS-ModifyFormintegration/api/odata/Forms({key})
PutWS-ModifyFormintegration/api/odata/Forms({key})

Key(s)
ID

Form Structural Properties

PropertyTypeNullableMandatoryRead-OnlyString lengthMin ValueMax ValuePrecisionMax Dec PlacesIs Only DateDescription
DateCreatedEdm.DateTimeOffsetfalsefalse true N/AN/AN/AN/AN/A
DateLastUpdatedEdm.DateTimeOffsetfalsefalse true N/AN/AN/AN/AN/A
DescriptionEdm.Stringtruefalse false 1000N/AN/AN/AN/A
DesignedByResourceIDEdm.Int32truefalse true N/AN/AN/AN/AN/A
FormStatusIDNlyte.Model.FormStatusfalsetrue false N/AN/AN/AN/AN/A
HasCascadingFormsEdm.Booleanfalsefalse true N/AN/AN/AN/AN/A
IDEdm.Int32falsefalse true N/AN/AN/AN/AN/A
IsHiddenEdm.Booleanfalsefalse true N/AN/AN/AN/AN/A
IsLatestVersionEdm.Booleanfalsefalse true N/AN/AN/AN/AN/A
LastUpdatedByResourceIDEdm.Int32truefalse true N/AN/AN/AN/AN/A
NameEdm.Stringfalsetrue false 250N/AN/AN/AN/A
RootFormIDEdm.Int32truefalse true N/AN/AN/AN/AN/A
SequenceNumberEdm.Int32falsefalse true N/AN/AN/AN/AN/A
VersionEdm.Int32falsefalse true N/AN/AN/AN/AN/A

Form Navigational Properties

PropertyType
ControlsCollection(Nlyte.Model.FormControl)
DesignedByResourceNlyte.Model.Resource
LastUpdatedByResourceNlyte.Model.Resource
ParentNlyte.Model.Form



FormBuilderMetaDataList Entity

Verb(s)Required Permission(s)LinkDescription

Key(s)
FormBuilderMetaDataListID

FormBuilderMetaDataList Structural Properties

PropertyTypeNullableMandatoryRead-OnlyString lengthMin ValueMax ValuePrecisionMax Dec PlacesIs Only DateDescription
DataFieldIDEdm.Int32falsefalse false N/AN/AN/AN/AN/A
DataFieldNameEdm.Stringtruefalse false N/AN/AN/AN/AN/A
DescriptionEdm.Stringtruefalse false N/AN/AN/AN/AN/A
FormBuilderMetaDataListIDEdm.Int32falsefalse false N/AN/AN/AN/AN/A
ItemOrderEdm.Int32falsefalse false N/AN/AN/AN/AN/A
NameEdm.Stringfalsetrue false N/AN/AN/AN/AN/A

FormBuilderMetaDataList Navigational Properties

No navigational properties


FormControl Entity

Verb(s)Required Permission(s)LinkDescription

Key(s)
ID

FormControl Structural Properties

PropertyTypeNullableMandatoryRead-OnlyString lengthMin ValueMax ValuePrecisionMax Dec PlacesIs Only DateDescription
ColumnPositionEdm.Int32falsetrue false N/AN/AN/AN/AN/A
ControlTypeIDNlyte.Model.FormControlTypefalsefalse true N/AN/AN/AN/AN/A
DependencyFormControlIDEdm.Int32truefalse false N/AN/AN/AN/AN/A
DependencyFormControlTypeIDNlyte.Model.DependencyTypefalsefalse false N/AN/AN/AN/AN/A
DependencyFormControlValueEdm.Stringtruefalse false 2147483647N/AN/AN/AN/A
FormIDEdm.Int32truefalse true N/AN/AN/AN/AN/A
IDEdm.Int32falsetrue false N/AN/AN/AN/AN/A
IsRequiredEdm.Booleanfalsefalse false N/AN/AN/AN/AN/A
LabelEdm.Stringtruefalse false 250N/AN/AN/AN/A
ParentFormControlIDEdm.Int32truefalse false N/AN/AN/AN/AN/A
RequiredInEmailEdm.Booleanfalsetrue false N/AN/AN/AN/AN/A
RowPositionEdm.Int32falsetrue false N/AN/AN/AN/AN/A
ToolTipEdm.Stringtruefalse false 250N/AN/AN/AN/A

FormControl Navigational Properties

PropertyType
CascadingFormsCollection(Nlyte.Model.CascadingForm)
DependencyFormControlNlyte.Model.FormControl
FormNlyte.Model.Form
ReportingTagsCollection(Nlyte.Model.FormControlReportingTag)



FormControlReportingTag Entity

Verb(s)Required Permission(s)LinkDescription

Key(s)
ID

FormControlReportingTag Structural Properties

PropertyTypeNullableMandatoryRead-OnlyString lengthMin ValueMax ValuePrecisionMax Dec PlacesIs Only DateDescription
IDEdm.Int32falsefalse false N/AN/AN/AN/AN/A
ReportingTagIDEdm.Int32truefalse false N/AN/AN/AN/AN/A

FormControlReportingTag Navigational Properties

PropertyType
ReportingTagNlyte.Model.ReportingTag



FormInstanceControlValue Entity

Verb(s)Required Permission(s)LinkDescription

Key(s)
ID

FormInstanceControlValue Structural Properties

PropertyTypeNullableMandatoryRead-OnlyString lengthMin ValueMax ValuePrecisionMax Dec PlacesIs Only DateDescription
ControlTypeIDNlyte.Model.FormControlTypefalsefalse true N/AN/AN/AN/AN/A
ControlValueNlyte.Model.ControlValueSummaryfalsetrue false N/AN/AN/AN/AN/A
FormControlIDEdm.Int32truetrue false N/AN/AN/AN/AN/A
FormIDEdm.Int32truetrue false N/AN/AN/AN/AN/A
FormInstanceIDEdm.Int32falsetrue false N/AN/AN/AN/AN/A
IDEdm.Int32falsetrue false N/AN/AN/AN/AN/A
RootFormInstanceIDEdm.Int32truefalse false N/AN/AN/AN/AN/A

FormInstanceControlValue Navigational Properties

PropertyType
FormNlyte.Model.Form
FormControlNlyte.Model.FormControl
ServiceRequestNlyte.Model.ServiceRequest
TaskInstanceNlyte.Model.TaskInstance



FunctionalUse Entity

Verb(s)Required Permission(s)LinkDescription

Key(s)
FunctionalUseID

FunctionalUse Structural Properties

PropertyTypeNullableMandatoryRead-OnlyString lengthMin ValueMax ValuePrecisionMax Dec PlacesIs Only DateDescription
DetailEdm.Stringfalsetrue false 50N/AN/AN/AN/AFunctional use description
FunctionalUseIDEdm.Int32falsefalse false N/AN/AN/AN/AN/A

FunctionalUse Navigational Properties

No navigational properties


Graph Entity - Entity providing details of a power connection

Verb(s)Required Permission(s)LinkDescription
GetWS-ReadAssetToAssetMappingintegration/api/odata/Graphs, integration/api/odata/Graphs({key})
PostWS-AddAssetToAssetMapping
PostWithKeyWS-ModifyAssetToAssetMapping
PatchWS-ModifyAssetToAssetMapping
DeleteWS-ModifyAssetToAssetMapping

Key(s)
GraphID

Graph Structural Properties

PropertyTypeNullableMandatoryRead-OnlyString lengthMin ValueMax ValuePrecisionMax Dec PlacesIs Only DateDescription
CableTypeEdm.Stringtruefalse false 10N/AN/AN/AN/A
ConnectionColorEdm.Int32true false
ConnectionLengthEdm.Decimaltrue false
ConnectionNameEdm.Stringtrue false
CrossSectionalAreaIDEdm.Int32truefalse false N/AN/AN/AN/AN/A
GraphIDEdm.Int32falsefalse true N/AN/AN/AN/AN/APrimary key, identifying uniquely a power connection.
InputAssetIDEdm.Int32truefalse true N/AN/AN/AN/AN/A
InputConnectorIDEdm.Int32truefalse false N/AN/AN/AN/AN/AForeign key for the entity representing the input plug used for the connection
MaxKVAEdm.Decimaltruefalse false N/A099999999.9999124The max KVA value provided by the user when creating a power connection
OutputAssetIDEdm.Int32truefalse false N/AN/AN/AN/AN/A
OutputConnectorIDEdm.Int32truefalse false N/AN/AN/AN/AN/A

Graph Navigational Properties

PropertyType
CrossSectionalAreaNlyte.Model.CrossSectionalArea
InputAssetNlyte.Model.Asset
InputConnectorNlyte.Model.InputConnector
OutputAssetNlyte.Model.Asset
OutputConnectorNlyte.Model.OutputConnector



Grid Entity

Verb(s)Required Permission(s)LinkDescription
GetWS-ReadRoomPlan
PatchWS-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
PutWS-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

Key(s)
ID

Grid Structural Properties

PropertyTypeNullableMandatoryRead-OnlyString lengthMin ValueMax ValuePrecisionMax Dec PlacesIs Only DateDescription
ColumnCountEdm.Int32falsefalse false N/AN/AN/AN/AN/A
ColumnSizeEdm.Decimalfalsefalse false N/AN/AN/AN/AN/A
IDEdm.Int32falsefalse false N/AN/AN/AN/AN/A
IsVisibleEdm.Booleanfalsefalse false N/AN/AN/AN/AN/A
OffsetXEdm.Decimalfalsefalse false N/A-9999999.9999999999.999103
OffsetYEdm.Decimalfalsefalse false N/A-9999999.9999999999.999103
PolygonIDEdm.Int32truefalse true N/AN/AN/AN/AN/A
RowCountEdm.Int32falsefalse false N/AN/AN/AN/AN/A
RowSizeEdm.Decimalfalsefalse false N/AN/AN/AN/AN/A
SaveActionNlyte.Model.SaveActionEnumfalsefalse false N/AN/AN/AN/AN/A

Grid Navigational Properties

PropertyType
GridLabelsCollection(Nlyte.Model.GridLabel)
PolygonNlyte.Model.Polygon



GridLabel Entity

Verb(s)Required Permission(s)LinkDescription
GetWS-ReadFloorPlannerGridLabel
PatchWS-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
PutWS-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

Key(s)
ID

GridLabel Structural Properties

PropertyTypeNullableMandatoryRead-OnlyString lengthMin ValueMax ValuePrecisionMax Dec PlacesIs Only DateDescription
GridIDEdm.Int32truefalse false N/AN/AN/AN/AN/A
IDEdm.Int32falsefalse false N/AN/AN/AN/AN/A
PositionIndexEdm.Int32falsefalse true N/AN/AN/AN/AN/A
PositionOnGridEdm.Int32falsefalse true N/AN/AN/AN/AN/A
SaveActionNlyte.Model.SaveActionEnumfalsefalse false N/AN/AN/AN/AN/A
TextEdm.Stringtruetrue false 10N/AN/AN/AN/A

GridLabel Navigational Properties

PropertyType
GridNlyte.Model.Grid



Group Entity - Generic entity representing any group

Verb(s)Required Permission(s)LinkDescription
GetWS-ReadBusinessGroup,WS-ReadSupportGroupintegration/api/odata/Groups({key}), integration/api/odata/Groups, integration/api/odata/Groups({key})

Key(s)
ID

Group Structural Properties

PropertyTypeNullableMandatoryRead-OnlyString lengthMin ValueMax ValuePrecisionMax Dec PlacesIs Only DateDescription
DescriptionEdm.Stringtruefalse false N/AN/AN/AN/AN/A
EmailAddressEdm.Stringtruefalse false N/AN/AN/AN/AN/A
GroupIDEdm.Int32falsefalse false N/AN/AN/AN/AN/A
GroupNameEdm.Stringtruefalse false N/AN/AN/AN/AN/A
GroupNumberEdm.Int32truefalse false N/AN/AN/AN/AN/A
GroupTypeNlyte.Model.GroupTypefalsefalse false N/AN/AN/AN/AN/AGroup type: support group or business group
IDEdm.Int64falsefalse false N/AN/AN/AN/AN/A
RecordStatusNlyte.Model.OrganisationGroupRecordStatusfalsefalse false N/AN/AN/AN/AN/AReflects the real status of the group as is in the data-center Canceled or Active.
TelephoneNumberEdm.Stringtruefalse false N/AN/AN/AN/AN/A

Group Navigational Properties

No navigational properties


HostFile Entity : File

Verb(s)Required Permission(s)LinkDescription
GetWS-ReadFile
DeleteWS-ModifyFile

Key(s)
Name

HostFile Structural Properties

No structural properties

HostFile Navigational Properties

No navigational properties


HostMapping Entity

Verb(s)Required Permission(s)LinkDescription

Key(s)
HostMapID

HostMapping Structural Properties

PropertyTypeNullableMandatoryRead-OnlyString lengthMin ValueMax ValuePrecisionMax Dec PlacesIs Only DateDescription
CreatedEdm.DateTimeOffsetfalsefalse false N/AN/AN/AN/AN/AIsOnlyDate
DiscoveredEdm.DateTimeOffsettruefalse false N/AN/AN/AN/AN/AIsOnlyDate
ExternalIDEdm.Stringtruefalse false 512N/AN/AN/AN/A
ExternalNameEdm.Stringtruefalse false 70N/AN/AN/AN/A
HostMapIDEdm.Int32falsefalse false N/AN/AN/AN/AN/A
HostNumberEdm.Int32falsefalse false N/AN/AN/AN/AN/A
LastUpdatedEdm.DateTimeOffsetfalsefalse false N/AN/AN/AN/AN/AIsOnlyDate
ProviderIDEdm.Guidtruefalse false N/AN/AN/AN/AN/A
ServerHostIDEdm.Int32truefalse false N/AN/AN/AN/AN/A
URLEdm.Stringtruefalse false 2048N/AN/AN/AN/A

HostMapping Navigational Properties

PropertyType
ServerHostNlyte.Model.ServerHost



HostNote Entity : Note

Verb(s)Required Permission(s)LinkDescription
PostWS-AddNote
PatchWS-ModifyNote
DeleteWS-ModifyNote
GetWS-ReadNote

Key(s)
NoteID

HostNote Structural Properties

No structural properties

HostNote Navigational Properties

No navigational properties


ImportedProcessResult Entity

Verb(s)Required Permission(s)LinkDescription

Key(s)
ID

ImportedProcessResult Structural Properties

PropertyTypeNullableMandatoryRead-OnlyString lengthMin ValueMax ValuePrecisionMax Dec PlacesIs Only DateDescription
IDEdm.Int32falsefalse false N/AN/AN/AN/AN/A
WarningsCollection(Edm.String)truefalse false N/AN/AN/AN/AN/A

ImportedProcessResult Navigational Properties

PropertyType
ImportedProcessNlyte.Model.Process



InputConnector Entity - Entity providing details for the input plug used for the connection

Verb(s)Required Permission(s)LinkDescription

Key(s)
InputConnectorID

InputConnector Structural Properties

PropertyTypeNullableMandatoryRead-OnlyString lengthMin ValueMax ValuePrecisionMax Dec PlacesIs Only DateDescription
AssetIDEdm.Int32truefalse false N/AN/AN/AN/AN/AThe asset ID of the Input Asset
InputConnectorIDEdm.Int32falsefalse false N/AN/AN/AN/AN/APrimary key
InputConnectorMaterialIDEdm.Int32truefalse false N/AN/AN/AN/AN/AInput plug material, associated to the material from which the above AssetID was created from.
PriorityEdm.Int32falsefalse false N/AN/AN/AN/AN/APlug priority defined on the material level

InputConnector Navigational Properties

PropertyType
InputConnectorMaterialNlyte.Model.InputConnectorMaterial
PowerAssetNlyte.Model.Asset



InputConnectorMaterial Entity - Input plug material, associated to the main material

Verb(s)Required Permission(s)LinkDescription

Key(s)
InputConnectorMaterialID

InputConnectorMaterial Structural Properties

PropertyTypeNullableMandatoryRead-OnlyString lengthMin ValueMax ValuePrecisionMax Dec PlacesIs Only DateDescription
InputConnectorMaterialIDEdm.Int32falsefalse false N/AN/AN/AN/AN/APrimary key
InputConnectorTypeIDEdm.Int32truefalse false N/AN/AN/AN/AN/AThe ID of one of the predefined input connector types.
MaterialIDEdm.Int32truefalse true N/AN/AN/AN/AN/AThe parent material, holding the plug
PositionEdm.Int32falsefalse false N/AN/AN/AN/AN/APlug position, read-only information
PriorityEdm.Int32falsefalse false N/AN/AN/AN/AN/APlug priority defined on the material level

InputConnectorMaterial Navigational Properties

PropertyType
InputConnectorTypeNlyte.Model.InputConnectorType
PowerMaterialNlyte.Model.PowerMaterial



InputConnectorType Entity

Verb(s)Required Permission(s)LinkDescription

Key(s)
InputConnectorTypeID

InputConnectorType Structural Properties

PropertyTypeNullableMandatoryRead-OnlyString lengthMin ValueMax ValuePrecisionMax Dec PlacesIs Only DateDescription
InputConnectorTypeIDEdm.Int32falsefalse false N/AN/AN/AN/AN/A
NameEdm.Stringfalsetrue false 50N/AN/AN/AN/A

InputConnectorType Navigational Properties

No navigational properties


IntegrationActivityParameter Entity

Verb(s)Required Permission(s)LinkDescription

Key(s)
ID

IntegrationActivityParameter Structural Properties

PropertyTypeNullableMandatoryRead-OnlyString lengthMin ValueMax ValuePrecisionMax Dec PlacesIs Only DateDescription
ActiveEdm.Booleanfalsefalse false N/AN/AN/AN/AN/A
BaseParameterIDEdm.Int32truefalse false N/AN/AN/AN/AN/A
CreatedDateEdm.DateTimeOffsetfalsefalse false N/AN/AN/AN/AN/A
DataTypeEdm.Stringfalsetrue false 200N/AN/AN/AN/A
DescriptionEdm.Stringtruefalse false 1000N/AN/AN/AN/A
DirectionIDEdm.Int32falsefalse false N/AN/AN/AN/AN/A
DisplayAsListEdm.Booleantruefalse false N/AN/AN/AN/AN/A
IDEdm.Int32falsefalse false N/AN/AN/AN/AN/A
IntegrationActivityIDEdm.Int32truefalse false N/AN/AN/AN/AN/A
LastUpdatedDateEdm.DateTimeOffsetfalsefalse false N/AN/AN/AN/AN/A
LengthEdm.Int32truefalse false N/AN/AN/AN/AN/A
NameEdm.Stringfalsetrue false 250N/AN/AN/AN/A
RequiredEdm.Booleanfalsefalse false N/AN/AN/AN/AN/A
UserFriendlyNameEdm.Stringtruefalse false 150N/AN/AN/AN/A

IntegrationActivityParameter Navigational Properties

PropertyType
IntegrationActivityParameterValueItemsCollection(Nlyte.Model.IntegrationActivityParameterValueItem)
IntegrationSystemActivityNlyte.Model.IntegrationSystemActivity
ParentNlyte.Model.IntegrationActivityParameter
TaskIntegrationAttributesCollection(Nlyte.Model.TaskIntegrationAttributes)



IntegrationActivityParameterValueItem Entity

Verb(s)Required Permission(s)LinkDescription

Key(s)
ID

IntegrationActivityParameterValueItem Structural Properties

PropertyTypeNullableMandatoryRead-OnlyString lengthMin ValueMax ValuePrecisionMax Dec PlacesIs Only DateDescription
ActiveEdm.Booleanfalsefalse false N/AN/AN/AN/AN/A
IDEdm.Int32falsefalse false N/AN/AN/AN/AN/A
IntegrationActivityParameterIDEdm.Int32truefalse false N/AN/AN/AN/AN/A
ParentIDEdm.Int32truefalse false N/AN/AN/AN/AN/A
PropertiesEdm.Stringfalsetrue false N/AN/AN/AN/AN/A
TextEdm.Stringfalsetrue false 500N/AN/AN/AN/A

IntegrationActivityParameterValueItem Navigational Properties

PropertyType
IntegrationActivityParameterNlyte.Model.IntegrationActivityParameter
ParentNlyte.Model.IntegrationActivityParameterValueItem



IntegrationSystem Entity

Verb(s)Required Permission(s)LinkDescription
GetWS-ReadProcessintegration/api/odata/IntegrationSystems, integration/api/odata/IntegrationSystems({key})

Key(s)
ID

IntegrationSystem Structural Properties

PropertyTypeNullableMandatoryRead-OnlyString lengthMin ValueMax ValuePrecisionMax Dec PlacesIs Only DateDescription
ActiveEdm.Booleanfalsefalse false N/AN/AN/AN/AN/A
CreatedDateEdm.DateTimeOffsetfalsefalse false N/AN/AN/AN/AN/A
DescriptionEdm.Stringtruefalse false 1000N/AN/AN/AN/A
EndSystemVersionEdm.Stringtruefalse false 75N/AN/AN/AN/A
GuidEdm.Guidfalsefalse false N/AN/AN/AN/AN/A
IDEdm.Int32falsefalse false N/AN/AN/AN/AN/A
LastUpdatedDateEdm.DateTimeOffsetfalsefalse false N/AN/AN/AN/AN/A
NameEdm.Stringfalsetrue false 250N/AN/AN/AN/A
PluginVersionEdm.Stringfalsetrue false 75N/AN/AN/AN/A
UserFriendlyNameEdm.Stringtruefalse false 150N/AN/AN/AN/A

IntegrationSystem Navigational Properties

PropertyType
ActivitiesCollection(Nlyte.Model.IntegrationSystemActivity)



IntegrationSystemActivity Entity

Verb(s)Required Permission(s)LinkDescription

Key(s)
ID

IntegrationSystemActivity Structural Properties

PropertyTypeNullableMandatoryRead-OnlyString lengthMin ValueMax ValuePrecisionMax Dec PlacesIs Only DateDescription
ActiveEdm.Booleanfalsefalse false N/AN/AN/AN/AN/A
CreatedDateEdm.DateTimeOffsetfalsefalse false N/AN/AN/AN/AN/A
DescriptionEdm.Stringtruefalse false 1000N/AN/AN/AN/A
IDEdm.Int32falsefalse false N/AN/AN/AN/AN/A
IntegrationSystemIDEdm.Int32truefalse false N/AN/AN/AN/AN/A
LastUpdatedDateEdm.DateTimeOffsetfalsefalse false N/AN/AN/AN/AN/A
NameEdm.Stringfalsetrue false 250N/AN/AN/AN/A
OnErrorActionIDEdm.Int32falsefalse false N/AN/AN/AN/AN/A
ServiceNameEdm.Stringfalsetrue false 250N/AN/AN/AN/A
TypeIDEdm.Int32truefalse false N/AN/AN/AN/AN/A
UserFriendlyNameEdm.Stringtruefalse false 150N/AN/AN/AN/A

IntegrationSystemActivity Navigational Properties

PropertyType
IntegrationSystemNlyte.Model.IntegrationSystem
IntegrationSystemActivityTypeNlyte.Model.IntegrationSystemActivityType
ParametersCollection(Nlyte.Model.IntegrationActivityParameter)



IntegrationSystemActivityType Entity

Verb(s)Required Permission(s)LinkDescription

Key(s)
ID

IntegrationSystemActivityType Structural Properties

PropertyTypeNullableMandatoryRead-OnlyString lengthMin ValueMax ValuePrecisionMax Dec PlacesIs Only DateDescription
DescriptionEdm.Stringfalsetrue false 50N/AN/AN/AN/A
IDEdm.Int32falsefalse false N/AN/AN/AN/AN/A

IntegrationSystemActivityType Navigational Properties

No navigational properties


InternalEquipmentCategory Entity

Verb(s)Required Permission(s)LinkDescription
GetWS-ReadInternalEquipmentItemintegration/api/odata/InternalEquipmentCategories, integration/api/odata/InternalEquipmentCategories({key})
PatchWS-ModifyInternalEquipmentItem
DeleteWS-ModifyInternalEquipmentItem
PostWS-AddInternalEquipmentItem

Key(s)
CategoryID

InternalEquipmentCategory Structural Properties

PropertyTypeNullableMandatoryRead-OnlyString lengthMin ValueMax ValuePrecisionMax Dec PlacesIs Only DateDescription
CategoryIDEdm.Int32falsefalse false N/AN/AN/AN/AN/A
CategoryNameEdm.Stringfalsetrue false 15N/AN/AN/AN/A
UnitEdm.Stringfalsetrue false 15N/AN/AN/AN/A

InternalEquipmentCategory Navigational Properties

PropertyType
InternalEquipmentCategorySizesCollection(Nlyte.Model.InternalEquipmentCategorySize)



InternalEquipmentCategorySize Entity - Sizes defined in the administration area

Verb(s)Required Permission(s)LinkDescription
GetWS-ReadInternalEquipmentItem
PatchWS-ModifyInternalEquipmentItem
DeleteWS-ModifyInternalEquipmentItem
PostWS-AddInternalEquipmentItem

Key(s)
CategorySizeID

InternalEquipmentCategorySize Structural Properties

PropertyTypeNullableMandatoryRead-OnlyString lengthMin ValueMax ValuePrecisionMax Dec PlacesIs Only DateDescription
CategoryIDEdm.Int32truefalse false N/AN/AN/AN/AN/AThe category that holds the current internal equipment category size.
CategorySizeIDEdm.Int32falsefalse false N/AN/AN/AN/AN/A
SizeEdm.Stringtruefalse false 50N/AN/AN/AN/A

InternalEquipmentCategorySize Navigational Properties

PropertyType
InternalEquipmentCategoryNlyte.Model.InternalEquipmentCategory



InternalEquipmentItem Entity - Entity representing the relation between the an entity and equipment defined in the administration area.

Verb(s)Required Permission(s)LinkDescription
GetWS-ReadInternalEquipmentItemintegration/api/odata/InternalEquipmentItems, integration/api/odata/InternalEquipmentItems({key})
PatchWS-ModifyInternalEquipmentItemintegration/api/odata/InternalEquipmentItems({key})
DeleteWS-ModifyInternalEquipmentItemintegration/api/odata/InternalEquipmentItems({key})
PostWithKeyWS-ModifyInternalEquipmentItem
PostWS-AddInternalEquipmentItemintegration/api/odata/InternalEquipmentItems

Key(s)
ItemID

InternalEquipmentItem Structural Properties

PropertyTypeNullableMandatoryRead-OnlyString lengthMin ValueMax ValuePrecisionMax Dec PlacesIs Only DateDescription
CategorySizeIDEdm.Int32truefalse false N/AN/AN/AN/AN/AValue defined in the administration area
EntityIDEdm.Int32truefalse false N/AN/AN/AN/AN/AThe asset for which the equipment is defined.
ItemCountEdm.Int32falsefalse false N/AN/AN/AN/AN/A
ItemIDEdm.Int32falsefalse true N/AN/AN/AN/AN/AThe selected equipment item id.
ItemNameEdm.Stringtruetrue false 30N/AN/AN/AN/A
ItemReferenceEdm.Int32truefalse true N/AN/AN/AN/AN/A

InternalEquipmentItem Navigational Properties

PropertyType
EntityNlyte.Model.Asset
InternalEquipmentCategorySizeNlyte.Model.InternalEquipmentCategorySize
NotesCollection(Nlyte.Model.InternalEquipmentItemNote)



InternalEquipmentItemNote Entity : Note

Verb(s)Required Permission(s)LinkDescription
PostWS-AddNote
PatchWS-ModifyNote
DeleteWS-ModifyNote
GetWS-ReadNote

Key(s)
NoteID

InternalEquipmentItemNote Structural Properties

No structural properties

InternalEquipmentItemNote Navigational Properties

No navigational properties


InternalEquipmentItemUtilisation Entity - An entity representing the mapping between the host, item utilization and physical partition

Verb(s)Required Permission(s)LinkDescription
GetWS-ReadInternalEquipmentItemUtilisationintegration/api/odata/InternalEquipmentItemUtilisations, integration/api/odata/InternalEquipmentItemUtilisations({key})
PatchWS-ModifyInternalEquipmentItemUtilisationintegration/api/odata/InternalEquipmentItemUtilisations({key})
DeleteWS-ModifyInternalEquipmentItemUtilisationintegration/api/odata/InternalEquipmentItemUtilisations({key})
PostWS-AddInternalEquipmentItemUtilisationintegration/api/odata/InternalEquipmentItemUtilisations

Key(s)
ItemUtilisationID

InternalEquipmentItemUtilisation Structural Properties

PropertyTypeNullableMandatoryRead-OnlyString lengthMin ValueMax ValuePrecisionMax Dec PlacesIs Only DateDescription
ItemIDEdm.Int32truefalse false N/AN/AN/AN/AN/A
ItemUtilisationIDEdm.Int32falsefalse false N/AN/AN/AN/AN/A
PhysicalPartitionIDEdm.Int32truefalse false N/AN/AN/AN/AN/A
PhysicalPartitionUtilisationPercentageEdm.Int32truefalse false N/AN/AN/AN/AN/A
ServerHostIDEdm.Int32truefalse false N/AN/AN/AN/AN/A
ServerHostUtilisationPercentageEdm.Int32truefalse false N/AN/AN/AN/AN/AEntity representing the relation between the an entity and equipment defined in the administration area.

InternalEquipmentItemUtilisation Navigational Properties

PropertyType
InternalEquipmentItemNlyte.Model.InternalEquipmentItem
NotesCollection(Nlyte.Model.InternalEquipmentItemUtilizationNote)
PhysicalPartitionNlyte.Model.PhysicalPartition
ServerHostNlyte.Model.ServerHost



InternalEquipmentItemUtilizationNote Entity : Note

Verb(s)Required Permission(s)LinkDescription
PostWS-AddNote
PatchWS-ModifyNote
DeleteWS-ModifyNote
GetWS-ReadNote

Key(s)
NoteID

InternalEquipmentItemUtilizationNote Structural Properties

No structural properties

InternalEquipmentItemUtilizationNote Navigational Properties

No navigational properties


IPAddress Entity - Entity providing details for the IP Address

Verb(s)Required Permission(s)LinkDescription

Key(s)
IPAddressID

IPAddress Structural Properties

PropertyTypeNullableMandatoryRead-OnlyString lengthMin ValueMax ValuePrecisionMax Dec PlacesIs Only DateDescription
IPEdm.Stringtruefalse true N/AN/AN/AN/AN/A
IPAddressIDEdm.Int32falsefalse false N/AN/AN/AN/AN/A
IPCIDREdm.Bytefalsetrue false N/AN/AN/AN/AN/A
IPOctetAEdm.Bytefalsetrue false N/AN/AN/AN/AN/A
IPOctetBEdm.Bytefalsetrue false N/AN/AN/AN/AN/A
IPOctetCEdm.Bytefalsetrue false N/AN/AN/AN/AN/A
IPOctetDEdm.Bytefalsetrue false N/AN/AN/AN/AN/A
IPUsageIDEdm.Int32truefalse false N/AN/AN/AN/AN/AUsage defined in the administration area.
SubnetEdm.Stringtruefalse true N/AN/AN/AN/AN/A
SubnetOctetAEdm.Bytefalsefalse true N/AN/AN/AN/AN/A
SubnetOctetBEdm.Bytefalsefalse true N/AN/AN/AN/AN/A
SubnetOctetCEdm.Bytefalsefalse true N/AN/AN/AN/AN/A
SubnetOctetDEdm.Bytefalsefalse true N/AN/AN/AN/AN/A

IPAddress Navigational Properties

PropertyType
IPUsageNlyte.Model.IPUsage
LinkedAssetsCollection(Nlyte.Model.AssetIPAddressMap)
LinkedServerHostsCollection(Nlyte.Model.ServerHostIPAddressMap)



IPAddressNetworkDependencyNote Entity : Note

Verb(s)Required Permission(s)LinkDescription
PostWS-AddNote
PatchWS-ModifyNote
DeleteWS-ModifyNote
GetWS-ReadNote

Key(s)
NoteID

IPAddressNetworkDependencyNote Structural Properties

No structural properties

IPAddressNetworkDependencyNote Navigational Properties

No navigational properties


IPUsage Entity

Verb(s)Required Permission(s)LinkDescription

Key(s)
IPUsageID

IPUsage Structural Properties

PropertyTypeNullableMandatoryRead-OnlyString lengthMin ValueMax ValuePrecisionMax Dec PlacesIs Only DateDescription
DetailEdm.Stringfalsetrue false 40N/AN/AN/AN/AIP Usage
IPUsageIDEdm.Int32falsefalse false N/AN/AN/AN/AN/A

IPUsage Navigational Properties

No navigational properties


Issue Entity

Verb(s)Required Permission(s)LinkDescription

Key(s)
ID

Issue Structural Properties

PropertyTypeNullableMandatoryRead-OnlyString lengthMin ValueMax ValuePrecisionMax Dec PlacesIs Only DateDescription
BodyEdm.Stringfalsetrue false 800N/AN/AN/AN/A
DateCreatedEdm.DateTimeOffsetfalsefalse true N/AN/AN/AN/AN/AIsOnlyDate
DateResolvedEdm.DateTimeOffsettruefalse true N/AN/AN/AN/AN/AIsOnlyDate
EntityIDEdm.Int32truefalse true N/AN/AN/AN/AN/A
ExpectedResolutionDateEdm.DateTimeOffsettruefalse false N/AN/AN/AN/AN/AIsOnlyDate
IDEdm.Int32falsefalse true N/AN/AN/AN/AN/A
ResourceIDEdm.Int32truefalse true N/AN/AN/AN/AN/A
SubjectEdm.Stringfalsetrue false 100N/AN/AN/AN/A
TypeIDNlyte.Model.IssueTypeWffalsetrue false N/AN/AN/AN/AN/A

Issue Navigational Properties

PropertyType
ResourceNlyte.Model.Resource
TaskInstanceNlyte.Model.TaskInstance



KeyboardPeripheralMaterial Entity : PeripheralMaterial

Verb(s)Required Permission(s)LinkDescription
GetWS-ReadPeripheralMaterialintegration/api/odata/KeyboardPeripheralMaterials, integration/api/odata/KeyboardPeripheralMaterials({key})
PostWS-AddPeripheralMaterialintegration/api/odata/KeyboardPeripheralMaterials
PostWithKeyWS-ModifyPeripheralMaterial
PatchWS-ModifyPeripheralMaterialintegration/api/odata/KeyboardPeripheralMaterials({key})
DeleteWS-ModifyPeripheralMaterialintegration/api/odata/KeyboardPeripheralMaterials({key})

Key(s)
MaterialID

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)LinkDescription
GetWS-ReadKVMSwitchintegration/api/odata/KVMSwitches, integration/api/odata/KVMSwitches({key})
PatchWS-ModifyKVMSwitchintegration/api/odata/KVMSwitches({key})
DeleteWS-ModifyKVMSwitchintegration/api/odata/KVMSwitches({key})
PostWithKeyWS-ModifyKVMSwitchintegration/api/odata/KVMSwitches({key})
PostWS-AddKVMSwitchintegration/api/odata/KVMSwitches

Key(s)
AssetID

KVMSwitch Structural Properties

PropertyTypeNullableMandatoryRead-OnlyString lengthMin ValueMax ValuePrecisionMax Dec PlacesIs Only DateDescription
AuditDateEdm.DateTimeOffsettruefalse false N/AN/AN/AN/AN/A
AuditStatusCorrectEdm.Booleantruefalse false N/AN/AN/AN/AN/A
FreePortsEdm.Int32falsefalse true N/AN/AN/AN/AN/A
LastAuditorAccountIDEdm.Int32truefalse false N/AN/AN/AN/AN/A
TotalPlugsEdm.Int32falsefalse true N/AN/AN/AN/AN/A

KVMSwitch Navigational Properties

PropertyType
AssetPortConsumerLinksCollection(Nlyte.Model.KVMSwitchPortConsumerLink)
CabinetsCollection(Nlyte.Model.KVMSwitchCabinetMap)
InputConnectorsCollection(Nlyte.Model.InputConnector)
KvmSwitchMaterialNlyte.Model.KVMSwitchMaterial
KvmSwitchPortConsumerLinksCollection(Nlyte.Model.KVMSwitchPortConsumerLink)
PeripheralsCollection(Nlyte.Model.PeripheralAssetLink)



KVMSwitchCabinetMap Entity

Verb(s)Required Permission(s)LinkDescription
GetWS-ReadKVMSwitchCabinetMap
PostWS-AddKVMSwitchCabinetMap
PatchWS-ModifyKVMSwitchCabinetMap
PostWithKeyWS-ModifyKVMSwitchCabinetMap
DeleteWS-ModifyKVMSwitchCabinetMap

Key(s)
KVMSwitchCabinetMapID

KVMSwitchCabinetMap Structural Properties

PropertyTypeNullableMandatoryRead-OnlyString lengthMin ValueMax ValuePrecisionMax Dec PlacesIs Only DateDescription
CabinetAssetIDEdm.Int32falsefalse false N/AN/AN/AN/AN/A
KVMSwitchAssetIDEdm.Int32falsefalse false N/AN/AN/AN/AN/A
KVMSwitchCabinetMapIDEdm.Int32falsefalse false N/AN/AN/AN/AN/A

KVMSwitchCabinetMap Navigational Properties

PropertyType
AssetNlyte.Model.KVMSwitch
CabinetAssetNlyte.Model.Cabinet



KVMSwitchMaterial Entity : Material - Material type inheriting properties from the base type

Verb(s)Required Permission(s)LinkDescription
GetWS-ReadKVMSwitchMaterialintegration/api/odata/KVMSwitchMaterials, integration/api/odata/KVMSwitchMaterials({key})
PostWS-AddKVMSwitchMaterialintegration/api/odata/KVMSwitchMaterials
PostWithKeyWS-ModifyKVMSwitchMaterialintegration/api/odata/KVMSwitchMaterials({key})
PatchWS-ModifyKVMSwitchMaterialintegration/api/odata/KVMSwitchMaterials({key})
DeleteWS-ModifyKVMSwitchMaterialintegration/api/odata/KVMSwitchMaterials({key})

Key(s)
MaterialID

KVMSwitchMaterial Structural Properties

PropertyTypeNullableMandatoryRead-OnlyString lengthMin ValueMax ValuePrecisionMax Dec PlacesIs Only DateDescription
CalculatedMpafPowerConsumptionEdm.Decimaltruefalse true N/AN/AN/AN/AN/ARead-only property, value provided by the service based on the PublishedPowerConsumption and the MpafOverride
ConsumerPowerFactorEdm.Decimalfalsefalse true N/AN/AN/AN/AN/ARead-only property representing the percentage of power drawn by a PDD material that is available to its asset consumers
MaterialCategoryIDEdm.Int32truefalse false N/AN/AN/AN/AN/A
MountingTypeIDNlyte.Model.MountingTypeEnumfalsefalse false N/AN/AN/AN/AN/A
MpafOverrideEdm.Decimaltruefalse false N/A0.00199963Value inserted by the user, while the material is in Planned status
NumberOfPortsEdm.Int32falsetrue false N/AN/AN/AN/AN/A
PowerTypeIDNlyte.Model.PowerTypeEnumfalsetrue false N/AN/AN/AN/AN/APower type: phased or direct current
PublishedPowerConsumptionEdm.Decimalfalsefalse false N/A0.00199963Value inserted by the user, while the material is in Planned status
RequiredPlugsEdm.Int32falsetrue false N/AN/AN/AN/AN/AValue inserted by the user, while the material is in Planned status
RequiresDiversePowerEdm.Booleanfalsefalse false N/AN/AN/AN/AN/AValue available to be updated by the user only if RequiredPlugs TotalPlugs
TotalPlugsEdm.Int32falsetrue false N/AN/AN/AN/AN/AValue inserted by the user, while the material is in Planned status
UHeightEdm.Int64falsefalse true N/AN/AN/AN/AN/A
WorkableFootPrintFrontEdm.Doublefalsefalse false N/A0999999999999.9999164
WorkableFootPrintHeightEdm.Doublefalsefalse false N/A0999999999999.9999164
WorkableFootPrintRearEdm.Doublefalsefalse false N/A0999999999999.9999164

KVMSwitchMaterial Navigational Properties

PropertyType
InputConnectorMaterialsCollection(Nlyte.Model.InputConnectorMaterial)



KVMSwitchPortConsumerLink Entity

Verb(s)Required Permission(s)LinkDescription
GetWS-ReadKVMSwitchPortConsumerLink
PostWS-AddKVMSwitchPortConsumerLink
PostWithKeyWS-ModifyKVMSwitchPortConsumerLink
PatchWS-ModifyKVMSwitchPortConsumerLink
DeleteWS-ModifyKVMSwitchPortConsumerLink

Key(s)
KVMSwitchPortConsumerLinkID

KVMSwitchPortConsumerLink Structural Properties

PropertyTypeNullableMandatoryRead-OnlyString lengthMin ValueMax ValuePrecisionMax Dec PlacesIs Only DateDescription
KVMSwitchAssetIDEdm.Int32falsefalse false N/AN/AN/AN/AN/A
KVMSwitchPortConsumerLinkIDEdm.Int32falsefalse false N/AN/AN/AN/AN/A
PortConsumerAssetIDEdm.Int32truetrue false N/AN/AN/AN/AN/A
PositionEdm.Int32falsefalse false N/AN/AN/AN/AN/A

KVMSwitchPortConsumerLink Navigational Properties

PropertyType
KvmSwitchNlyte.Model.KVMSwitch
PortConsumerAssetNlyte.Model.Asset



LabelControl Entity : FormControl

Verb(s)Required Permission(s)LinkDescription

Key(s)
ID

LabelControl Structural Properties

No structural properties

LabelControl Navigational Properties

No navigational properties


LabelControlValue Entity : FormInstanceControlValue

Verb(s)Required Permission(s)LinkDescription

Key(s)
ID

LabelControlValue Structural Properties

No structural properties

LabelControlValue Navigational Properties

No navigational properties


Layer Entity

Verb(s)Required Permission(s)LinkDescription

Key(s)
ID

Layer Structural Properties

PropertyTypeNullableMandatoryRead-OnlyString lengthMin ValueMax ValuePrecisionMax Dec PlacesIs Only DateDescription
IDEdm.Int32falsetrue false N/AN/AN/AN/AN/A
LayerTypeIDNlyte.Model.LayerTypefalsetrue true N/AN/AN/AN/AN/A
LocationGroupIDEdm.Int32truefalse true N/AN/AN/AN/AN/AForeign key identifying the location
LockedEdm.Booleanfalsefalse false N/AN/AN/AN/AN/A
NameEdm.Stringtruetrue false 50N/AN/AN/AN/A
SaveActionNlyte.Model.SaveActionEnumfalsefalse false N/AN/AN/AN/AN/A
VisibleEdm.Booleanfalsefalse false N/AN/AN/AN/AN/A
ZOrderEdm.Int32falsetrue false N/AN/AN/AN/AN/A

Layer Navigational Properties

PropertyType
LayerImageNlyte.Model.LayerImage
LocationGroupNlyte.Model.LocationGroup



LayerImage Entity

Verb(s)Required Permission(s)LinkDescription

Key(s)
LayerID

LayerImage Structural Properties

PropertyTypeNullableMandatoryRead-OnlyString lengthMin ValueMax ValuePrecisionMax Dec PlacesIs Only DateDescription
ImageEdm.Binarytruefalse false N/AN/AN/AN/AN/A
ImageFileTypeIDNlyte.Model.ImageFileTypefalsetrue false N/AN/AN/AN/AN/A
LayerIDEdm.Int32truetrue false N/AN/AN/AN/AN/A
LengthEdm.Decimalfalsetrue false N/A09999999999.99122
WidthEdm.Decimalfalsetrue false N/A09999999999.99122

LayerImage Navigational Properties

PropertyType
LayerNlyte.Model.Layer



License Entity - Entity providing details about the current license

Verb(s)Required Permission(s)LinkDescription

Key(s)
EditionID

License Structural Properties

PropertyTypeNullableMandatoryRead-OnlyString lengthMin ValueMax ValuePrecisionMax Dec PlacesIs Only DateDescription
CompanyEdm.Stringtruefalse false N/AN/AN/AN/AN/AThe company for which the license was issued
EditionIDEdm.Stringfalsefalse false N/AN/AN/AN/AN/A
EditionNameEdm.Stringtruefalse false N/AN/AN/AN/AN/A
ErrorEdm.Stringtruefalse false N/AN/AN/AN/AN/A
IsEvaluationEdm.Booleanfalsefalse false N/AN/AN/AN/AN/A
IsInitialisedEdm.Booleanfalsefalse false N/AN/AN/AN/AN/A
IsValidEdm.Booleanfalsefalse false N/AN/AN/AN/AN/ATrue is the license didn't expired.
ModulesCollection(Nlyte.Model.Module)falsefalse false N/AN/AN/AN/AN/AA collection of licensed modules.

License Navigational Properties

No navigational properties


ListItem Entity

Verb(s)Required Permission(s)LinkDescription

Key(s)
ID

ListItem Structural Properties

PropertyTypeNullableMandatoryRead-OnlyString lengthMin ValueMax ValuePrecisionMax Dec PlacesIs Only DateDescription
IDEdm.Int64falsefalse false N/AN/AN/AN/AN/A
ItemIDEdm.Int32falsefalse false N/AN/AN/AN/AN/A
ListTypeIDEdm.Int32truefalse false N/AN/AN/AN/AN/A
NameEdm.Stringtruefalse false N/AN/AN/AN/AN/A

ListItem Navigational Properties

PropertyType
ListTypeNlyte.Model.ListType



ListType Entity

Verb(s)Required Permission(s)LinkDescription

Key(s)
ListTypeID

ListType Structural Properties

PropertyTypeNullableMandatoryRead-OnlyString lengthMin ValueMax ValuePrecisionMax Dec PlacesIs Only DateDescription
DescriptionEdm.Stringtruefalse false N/AN/AN/AN/AN/A
ListTypeIDEdm.Int32falsefalse false N/AN/AN/AN/AN/A
RecordTypeIDEdm.Int32truefalse false N/AN/AN/AN/AN/A

ListType Navigational Properties

PropertyType
RecordListItemsCollection(Nlyte.Model.ListItem)
RecordTypeNlyte.Model.RecordType



LocationGroup Entity - Entity providing details about the location

Verb(s)Required Permission(s)LinkDescription

Key(s)
LocationGroupID

LocationGroup Structural Properties

PropertyTypeNullableMandatoryRead-OnlyString lengthMin ValueMax ValuePrecisionMax Dec PlacesIs Only DateDescription
AvailabilityMetricEdm.Booleanfalsefalse true N/AN/AN/AN/AN/A
CabinetUSpaceMetricEdm.Booleanfalsefalse true N/AN/AN/AN/AN/A
CloudProviderIdEdm.Int32truefalse true N/AN/AN/AN/AN/AThe selected cloud provider, from the available list defined in the administration area.
DecommissionEdm.Booleanfalsefalse true N/AN/AN/AN/AN/ATrue is the location can be used for action planning for decommission action.
DuplicateLocationGroupNameEdm.Stringtruefalse true 260N/AN/AN/AN/AThe unique location name, having the name as a concatenation of last hierarchical location names.
EnergyMeteringMetricEdm.Booleanfalsefalse true N/AN/AN/AN/AN/A
FacilityUtilizationMetricEdm.Booleanfalsefalse true N/AN/AN/AN/AN/A
HasChildrenEdm.Booleanfalsefalse true N/AN/AN/AN/AN/ATrue if the location acts as a parent for another location.
HasFLoorPlannerRoomEdm.Booleanfalsefalse true N/AN/AN/AN/AN/A
IsAccessibleEdm.Booleanfalsefalse true N/AN/AN/AN/AN/A
IsCloudEdm.Booleanfalsefalse true N/AN/AN/AN/AN/A
IsFloorViewableEdm.Booleantruefalse true N/AN/AN/AN/AN/ATrue if the the floor has one or more rooms which are accessible
LatitudeEdm.Decimaltruefalse true N/AN/AN/AN/AN/A
LocationAliasEdm.Stringtruefalse true 255N/AN/AN/AN/A
LocationGroupIDEdm.Int32truefalse false N/AN/AN/AN/AN/A
LocationGroupNameEdm.Stringtruefalse false 150N/AN/AN/AN/A
LocationGroupTypeNlyte.Model.LocationGroupTypeEnumfalsefalse true N/AN/AN/AN/AN/A
LocationPurposeIdEdm.Int32truefalse true N/AN/AN/AN/AN/AThe selected purpose, from the available list defined in the administration area.
LocationStatusIdEdm.Int32falsefalse true N/AN/AN/AN/AN/A
LocationTierIdEdm.Int32truefalse true N/AN/AN/AN/AN/A
LongitudeEdm.Decimaltruefalse true N/AN/AN/AN/AN/A
MonitoredEdm.Booleanfalsefalse false N/AN/AN/AN/AN/AIf true, the room is added to NEO
MonthlyCostEdm.Decimaltruefalse true N/A099999999999.99132
MoveEdm.Booleanfalsefalse true N/AN/AN/AN/AN/ATrue is the location can be used for action planning for move action.
ParentLocationGroupIDEdm.Int32truefalse true N/AN/AN/AN/AN/A
PUEMetricEdm.Booleanfalsefalse true N/AN/AN/AN/AN/A
RecycleEdm.Booleanfalsefalse true N/AN/AN/AN/AN/ATrue is the location can be used for action planning for recycle action.
ServerUtilizationMetricEdm.Booleanfalsefalse true N/AN/AN/AN/AN/A
TagEdm.Stringtruefalse false 40N/AN/AN/AN/A
UnderutilizedServerMetricEdm.Booleanfalsefalse true N/AN/AN/AN/AN/A
VirtualizationMetricEdm.Booleanfalsefalse true N/AN/AN/AN/AN/A
ZipCodeEdm.Stringtruefalse false 25N/AN/AN/AN/APostal / Zip Code for building locations.

LocationGroup Navigational Properties

PropertyType
AncestralLocationInfoNlyte.Model.AncestralInfo
CloudProviderNlyte.Model.CloudProvider
LocationPurposeNlyte.Model.LocationPurpose
NotesCollection(Nlyte.Model.LocationGroupNote)
ParentNlyte.Model.LocationGroup
ProcessesCollection(Nlyte.Model.Process)
UserAccountsCollection(Nlyte.Model.UserAccount)
UserGroupsCollection(Nlyte.Model.UserGroup)



LocationGroupNote Entity : Note

Verb(s)Required Permission(s)LinkDescription
PostWS-AddNote
PatchWS-ModifyNote
DeleteWS-ModifyNote
GetWS-ReadNote

Key(s)
NoteID

LocationGroupNote Structural Properties

PropertyTypeNullableMandatoryRead-OnlyString lengthMin ValueMax ValuePrecisionMax Dec PlacesIs Only DateDescription
SaveActionNlyte.Model.SaveActionEnumfalsefalse false N/AN/AN/AN/AN/A

LocationGroupNote Navigational Properties

No navigational properties


LocationPurpose Entity

Verb(s)Required Permission(s)LinkDescription

Key(s)
LocationPurposeId

LocationPurpose Structural Properties

PropertyTypeNullableMandatoryRead-OnlyString lengthMin ValueMax ValuePrecisionMax Dec PlacesIs Only DateDescription
DetailEdm.Stringfalsetrue false 255N/AN/AN/AN/ALocation purpose description
LocationPurposeIdEdm.Int32falsefalse false N/AN/AN/AN/AN/A

LocationPurpose Navigational Properties

No navigational properties


LogicalPartitionType Entity

Verb(s)Required Permission(s)LinkDescription

Key(s)
LogicalPartitionTypeID

LogicalPartitionType Structural Properties

PropertyTypeNullableMandatoryRead-OnlyString lengthMin ValueMax ValuePrecisionMax Dec PlacesIs Only DateDescription
DetailEdm.Stringfalsetrue false 40N/AN/AN/AN/A
LogicalPartitionTypeIDEdm.Int32falsefalse false N/AN/AN/AN/AN/A

LogicalPartitionType Navigational Properties

No navigational properties


Maintenance Entity

Verb(s)Required Permission(s)LinkDescription

Key(s)
AssetID

Maintenance Structural Properties

PropertyTypeNullableMandatoryRead-OnlyString lengthMin ValueMax ValuePrecisionMax Dec PlacesIs Only DateDescription
AssetIDEdm.Int32truefalse false N/AN/AN/AN/AN/A
CommentsEdm.Stringtruefalse false 1000N/AN/AN/AN/A
ContractRefEdm.Stringtruefalse false 40N/AN/AN/AN/A
EndDateEdm.DateTimeOffsettruefalse false N/AN/AN/AN/AN/AIsOnlyDate
LastDateEdm.DateTimeOffsettruefalse false N/AN/AN/AN/AN/AIsOnlyDate
MaintenanceAnnualMaintenanceEdm.Stringtruefalse false 40N/AN/AN/AN/A
MaintenanceCostCenterEdm.Stringtruefalse false 1000N/AN/AN/AN/A
MaintenanceDepreciationEdm.Stringtruefalse false 40N/AN/AN/AN/A
MaintenancePaymentScheduleEdm.Stringtruefalse false 1000N/AN/AN/AN/A
StartDateEdm.DateTimeOffsettruefalse false N/AN/AN/AN/AN/AIsOnlyDate

Maintenance Navigational Properties

PropertyType
AssetNlyte.Model.Asset



Manufacturer Entity

Verb(s)Required Permission(s)LinkDescription

Key(s)
ManufacturerID

Manufacturer Structural Properties

PropertyTypeNullableMandatoryRead-OnlyString lengthMin ValueMax ValuePrecisionMax Dec PlacesIs Only DateDescription
DetailEdm.Stringfalsetrue false 30N/AN/AN/AN/AManufacturer
ManufacturerIDEdm.Int32falsefalse false N/AN/AN/AN/AN/A

Manufacturer Navigational Properties

No navigational properties


Marker Entity

Verb(s)Required Permission(s)LinkDescription
GetWS-ReadRoomPlan
PatchWS-ModifyRoomPlan
PutWS-ModifyRoomPlan
DeleteWS-ModifyRoomPlan
PostWS-ModifyRoomPlan

Key(s)
ID

Marker Structural Properties

PropertyTypeNullableMandatoryRead-OnlyString lengthMin ValueMax ValuePrecisionMax Dec PlacesIs Only DateDescription
DisplayNameEdm.Booleanfalsefalse false N/AN/AN/AN/AN/A
IDEdm.Int32falsefalse false N/AN/AN/AN/AN/A
LayerIDEdm.Int32truetrue false N/AN/AN/AN/AN/A
OverlapsEdm.Booleanfalsefalse false N/AN/AN/AN/AN/A
PolygonIdEdm.Int32truefalse false N/AN/AN/AN/AN/A
PreventsItemAdditionEdm.Booleanfalsefalse false N/AN/AN/AN/AN/A
SaveActionNlyte.Model.SaveActionEnumfalsefalse false N/AN/AN/AN/AN/A

Marker Navigational Properties

PropertyType
LayerNlyte.Model.RoomLayer
PolygonNlyte.Model.Polygon



MasterBreaker Entity : Breaker - Entity providing details about a PDU master breaker

Verb(s)Required Permission(s)LinkDescription
GetWS-ReadPDUBreakerintegration/api/odata/MasterBreakers, integration/api/odata/MasterBreakers({key})

Key(s)
BreakerID

MasterBreaker Structural Properties

PropertyTypeNullableMandatoryRead-OnlyString lengthMin ValueMax ValuePrecisionMax Dec PlacesIs Only DateDescription
Child1BreakerIDEdm.Int32truefalse false N/AN/AN/AN/AN/AThe key that identifies the first child breaker.
Child1PhaseColourEdm.Stringtruefalse false 255N/AN/AN/AN/A
Child1PhaseColourIndexEdm.Int32truefalse true N/AN/AN/AN/AN/A
Child1PositionEdm.Int32truefalse false N/AN/AN/AN/AN/A
Child2BreakerIDEdm.Int32truefalse false N/AN/AN/AN/AN/AThe key that identifies the second child breaker.
Child2PhaseColourEdm.Stringtruefalse false 255N/AN/AN/AN/A
Child2PhaseColourIndexEdm.Int32truefalse true N/AN/AN/AN/AN/A
Child2PositionEdm.Int32truefalse false N/AN/AN/AN/AN/A

MasterBreaker Navigational Properties

No navigational properties


Material Entity - Entity representing a generic material, acting as base class for specific material types.

Verb(s)Required Permission(s)LinkDescription
GetWS-ReadAirConditioningMaterial,WS-ReadAuxiliaryMaterial,WS-ReadCabinetMaterial,WS-ReadChassisMaterial,WS-ReadKVMSwitchMaterial,WS-ReadNetworkMaterial,WS-ReadPDUMaterial,WS-ReadPeripheralMaterial,WS-ReadPowerStripMaterial,WS-ReadReceptacleMaterial,WS-ReadServerMaterial,WS-ReadStaticSwitchMaterial,WS-ReadUPSMaterialintegration/api/odata/Materials, integration/api/odata/Materials({key})

Key(s)
MaterialID

Material Structural Properties

PropertyTypeNullableMandatoryRead-OnlyString lengthMin ValueMax ValuePrecisionMax Dec PlacesIs Only DateDescription
ExternalDepthEdm.Doubletruefalse false N/AN/AN/AN/AN/A
ExternalHeightEdm.Doubletruefalse false N/AN/AN/AN/AN/A
ExternalWidthEdm.Doubletruefalse false N/AN/AN/AN/AN/A
IsEditableEdm.Booleantruefalse true N/AN/AN/AN/AN/AFalse means that is nlyte supplied.
ManufacturerIDEdm.Int32truetrue false N/AN/AN/AN/AN/AThe manufacturer ID, used from the predefined list of manufacturers.
MaterialIDEdm.Int32falsefalse true N/AN/AN/AN/AN/A
MaterialNameEdm.Stringfalsetrue false 100N/AN/AN/AN/AName of the Material. This needs to be unique in the system.
MaterialNumberEdm.Int32truefalse true N/AN/AN/AN/AN/A
MaterialTypeIDEdm.Int32truefalse true N/AN/AN/AN/AN/AMaterial type foreign key
ModelEdm.Stringfalsetrue false 255N/AN/AN/AN/A
RecordStatusNlyte.Model.MaterialRecordStatusfalsetrue false N/AN/AN/AN/AN/AReflects the real status of the material as is in the data-center.
WeightEdm.Doubletruefalse false N/AN/AN/AN/AN/A

Material Navigational Properties

PropertyType
FilesCollection(Nlyte.Model.MaterialFile)
ManufacturerNlyte.Model.Manufacturer
MaterialCategoryNlyte.Model.MaterialCategory
MaterialSubtypeNlyte.Model.MaterialSubtype
MaterialTypeNlyte.Model.MaterialType



MaterialAndSoftware Entity - Generic entity that represents any material type including softwares.

Verb(s)Required Permission(s)LinkDescription
GetWS-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-ReadSoftwareintegration/api/odata/MaterialsAndSoftware, integration/api/odata/MaterialsAndSoftware({key})

Key(s)
ID

MaterialAndSoftware Structural Properties

PropertyTypeNullableMandatoryRead-OnlyString lengthMin ValueMax ValuePrecisionMax Dec PlacesIs Only DateDescription
IDEdm.Int64falsefalse false N/AN/AN/AN/AN/A
ManufacturerEdm.Stringtruefalse false N/AN/AN/AN/AN/A
MaterialIDEdm.Int32falsefalse false N/AN/AN/AN/AN/A
MaterialNameEdm.Stringtruefalse false N/AN/AN/AN/AN/A
MaterialNumberEdm.Int32truefalse false N/AN/AN/AN/AN/A
MaterialTypeEdm.Stringtruefalse false N/AN/AN/AN/AN/AEntity representing the material type. Once an asset is created from a material, the asset type will be the material type from which was created.
MaterialTypeIDEdm.Int32falsefalse false N/AN/AN/AN/AN/AEntity representing the material type. Once an asset is created from a material, the asset type will be the material type from which was created.
RecordStatusNlyte.Model.MaterialRecordStatusfalsefalse false N/AN/AN/AN/AN/AReflects the real status of the group as is in the data-center Canceled or Active.

MaterialAndSoftware Navigational Properties

No navigational properties


MaterialCategory Entity - The material category assigned to the a material sub-type. Available categories are defined in the administration area

Verb(s)Required Permission(s)LinkDescription

Key(s)
MaterialCategoryID

MaterialCategory Structural Properties

PropertyTypeNullableMandatoryRead-OnlyString lengthMin ValueMax ValuePrecisionMax Dec PlacesIs Only DateDescription
ActiveEdm.Booleanfalsefalse false N/AN/AN/AN/AN/A
MaterialCategoryIDEdm.Int32falsefalse false N/AN/AN/AN/AN/A
MaterialSubtypeIDEdm.Int32truefalse false N/AN/AN/AN/AN/AThe material sub-type for which the category is available.
NameEdm.Stringfalsetrue false 255N/AN/AN/AN/A

MaterialCategory Navigational Properties

PropertyType
MaterialSubtypeNlyte.Model.MaterialSubtype



MaterialFile Entity : File

Verb(s)Required Permission(s)LinkDescription
GetWS-ReadFile
DeleteWS-ModifyFile

Key(s)
Name

MaterialFile Structural Properties

No structural properties

MaterialFile Navigational Properties

No navigational properties


MaterialImage Entity - Image associated to the material

Verb(s)Required Permission(s)LinkDescription

Key(s)
MaterialImageID

MaterialImage Structural Properties

PropertyTypeNullableMandatoryRead-OnlyString lengthMin ValueMax ValuePrecisionMax Dec PlacesIs Only DateDescription
ImageDataEdm.Binarytruefalse false N/AN/AN/AN/AN/A
MaterialIDEdm.Int32falsefalse false N/AN/AN/AN/AN/AMaterial for which the image was uploaded.
MaterialImageIDEdm.Int32falsefalse false N/AN/AN/AN/AN/A
MaterialImageTypeIDNlyte.Model.MaterialImageTypeEnumfalsefalse false N/AN/AN/AN/AN/AImage representing the front or the back of the asset.

MaterialImage Navigational Properties

PropertyType
MaterialNlyte.Model.Material



MaterialSubtype Entity

Verb(s)Required Permission(s)LinkDescription

Key(s)
MaterialSubtypeID

MaterialSubtype Structural Properties

PropertyTypeNullableMandatoryRead-OnlyString lengthMin ValueMax ValuePrecisionMax Dec PlacesIs Only DateDescription
MaterialSubtypeIDEdm.Int32falsefalse false N/AN/AN/AN/AN/A
MaterialTypeIDEdm.Int32truefalse false N/AN/AN/AN/AN/A
NameEdm.Stringfalsetrue false 50N/AN/AN/AN/A

MaterialSubtype Navigational Properties

PropertyType
MaterialTypeNlyte.Model.MaterialType



MaterialType Entity

Verb(s)Required Permission(s)LinkDescription

Key(s)
MaterialTypeID

MaterialType Structural Properties

PropertyTypeNullableMandatoryRead-OnlyString lengthMin ValueMax ValuePrecisionMax Dec PlacesIs Only DateDescription
DetailEdm.Stringfalsetrue false 50N/AN/AN/AN/AMaterial type description
MaterialTypeIDEdm.Int32falsefalse false N/AN/AN/AN/AN/A

MaterialType Navigational Properties

No navigational properties


Measurement Entity

Verb(s)Required Permission(s)LinkDescription
GetWS-ReadRoomPlan
PatchWS-ModifyRoomPlan
PutWS-ModifyRoomPlan
DeleteWS-ModifyRoomPlan
PostWS-ModifyRoomPlan

Key(s)
ID

Measurement Structural Properties

PropertyTypeNullableMandatoryRead-OnlyString lengthMin ValueMax ValuePrecisionMax Dec PlacesIs Only DateDescription
DisplayLabelsEdm.Booleanfalsefalse false N/AN/AN/AN/AN/A
IDEdm.Int32falsetrue false N/AN/AN/AN/AN/A
LayerIDEdm.Int32truetrue false N/AN/AN/AN/AN/A
NameEdm.Stringtruefalse false 50N/AN/AN/AN/A
ParentLocationGroupIDEdm.Int32truefalse true N/AN/AN/AN/AN/A
PolygonIDEdm.Int32truefalse true N/AN/AN/AN/AN/A
SaveActionNlyte.Model.SaveActionEnumfalsefalse false N/AN/AN/AN/AN/A

Measurement Navigational Properties

PropertyType
LayerNlyte.Model.RoomLayer
LocationGroupNlyte.Model.LocationGroup
PolygonNlyte.Model.Polygon
RoomNlyte.Model.Room



MeasurementSystem Entity

Verb(s)Required Permission(s)LinkDescription

Key(s)
ID

MeasurementSystem Structural Properties

PropertyTypeNullableMandatoryRead-OnlyString lengthMin ValueMax ValuePrecisionMax Dec PlacesIs Only DateDescription
DescriptionEdm.Stringfalsetrue false 50N/AN/AN/AN/A
IDEdm.Int32falsefalse false N/AN/AN/AN/AN/A

MeasurementSystem Navigational Properties

No navigational properties


ModuleNetworkMaterial Entity : NetworkMaterial

Verb(s)Required Permission(s)LinkDescription
GetWS-ReadNetworkMaterialintegration/api/odata/ModuleNetworkMaterials, integration/api/odata/ModuleNetworkMaterials({key})
PostWS-AddNetworkMaterialintegration/api/odata/ModuleNetworkMaterials
PostWithKeyWS-ModifyNetworkMaterial
PatchWS-ModifyNetworkMaterialintegration/api/odata/ModuleNetworkMaterials({key})
DeleteWS-ModifyNetworkMaterialintegration/api/odata/ModuleNetworkMaterials({key})

Key(s)
MaterialID

ModuleNetworkMaterial Structural Properties

PropertyTypeNullableMandatoryRead-OnlyString lengthMin ValueMax ValuePrecisionMax Dec PlacesIs Only DateDescription
CalculatedMpafPowerConsumptionEdm.Decimaltruefalse true N/AN/AN/AN/AN/ARead-only property, value provided by the service based on the PublishedPowerConsumption and the MpafOverride
ConsumerPowerFactorEdm.Decimalfalsefalse true N/AN/AN/AN/AN/A
MaterialCategoryIDEdm.Int32truefalse false N/AN/AN/AN/AN/A
MpafOverrideEdm.Decimaltruefalse false N/A0.00199963Value inserted by the user, while the material is in Planned status
NumberOfColumnsEdm.Int32truefalse false N/AN/AN/AN/AN/A
NumberOfRowsEdm.Int32truefalse false N/AN/AN/AN/AN/A
PublishedPowerConsumptionEdm.Decimaltruetrue false N/A0.00199963Value inserted by the user, while the material is in Planned status
WorkableFootPrintFrontEdm.Doublefalsefalse false N/A0999999999999.9999164
WorkableFootPrintHeightEdm.Doublefalsefalse false N/A0999999999999.9999164
WorkableFootPrintRearEdm.Doublefalsefalse false N/A0999999999999.9999164

ModuleNetworkMaterial Navigational Properties

No navigational properties


MonitorPeripheralMaterial Entity : PeripheralMaterial

Verb(s)Required Permission(s)LinkDescription
GetWS-ReadPeripheralMaterialintegration/api/odata/MonitorPeripheralMaterials, integration/api/odata/MonitorPeripheralMaterials({key})
PostWS-AddPeripheralMaterialintegration/api/odata/MonitorPeripheralMaterials
PostWithKeyWS-ModifyPeripheralMaterialintegration/api/odata/MonitorPeripheralMaterials({key})
PatchWS-ModifyPeripheralMaterialintegration/api/odata/MonitorPeripheralMaterials({key})
DeleteWS-ModifyPeripheralMaterialintegration/api/odata/MonitorPeripheralMaterials({key})

Key(s)
MaterialID

MonitorPeripheralMaterial Structural Properties

PropertyTypeNullableMandatoryRead-OnlyString lengthMin ValueMax ValuePrecisionMax Dec PlacesIs Only DateDescription
AirflowTypeIDNlyte.Model.AirflowTypeEnumtruetrue false N/AN/AN/AN/AN/ASelected air flow, from the available values defined in the administration area
CalculatedMpafPowerConsumptionEdm.Decimaltruefalse true N/AN/AN/AN/AN/A
ConsumerPowerFactorEdm.Decimalfalsefalse true N/AN/AN/AN/AN/A
MpafOverrideEdm.Decimaltruefalse false N/A0.00199963Value inserted by the user, while the material is in Planned status
PowerTypeIDNlyte.Model.PowerTypeEnumtruetrue false N/AN/AN/AN/AN/APower type: phased or direct current
PublishedPowerConsumptionEdm.Decimaltruefalse false N/A0.00199963Value inserted by the user, while the material is in Planned status
RequiredPlugsEdm.Int32truetrue false N/AN/AN/AN/AN/AValue inserted by the user, while the material is in Planned status
RequiresDiversePowerEdm.Booleantruefalse false N/AN/AN/AN/AN/AValue available to be updated by the user only if RequiredPlugs TotalPlugs
TotalPlugsEdm.Int32truetrue false N/AN/AN/AN/AN/AValue inserted by the user, while the material is in Planned status
WorkableFootPrintFrontEdm.Doublefalsefalse false N/A0999999999999.9999164
WorkableFootPrintHeightEdm.Doublefalsefalse false N/A0999999999999.9999164
WorkableFootPrintRearEdm.Doublefalsefalse false N/A0999999999999.9999164

MonitorPeripheralMaterial Navigational Properties

PropertyType
InputConnectorMaterialsCollection(Nlyte.Model.InputConnectorMaterial)
MountingTypeNlyte.Model.MountingType



MountingType Entity

Verb(s)Required Permission(s)LinkDescription

Key(s)
MountingTypeID

MountingType Structural Properties

PropertyTypeNullableMandatoryRead-OnlyString lengthMin ValueMax ValuePrecisionMax Dec PlacesIs Only DateDescription
DetailEdm.Stringtruefalse false N/AN/AN/AN/AN/A
MountingTypeIDEdm.Int32falsefalse false N/AN/AN/AN/AN/A

MountingType Navigational Properties

No navigational properties


MousePeripheralMaterial Entity : PeripheralMaterial

Verb(s)Required Permission(s)LinkDescription
GetWS-ReadPeripheralMaterialintegration/api/odata/MousePeripheralMaterials, integration/api/odata/MousePeripheralMaterials({key})
PostWS-AddPeripheralMaterialintegration/api/odata/MousePeripheralMaterials
PostWithKeyWS-ModifyPeripheralMaterial
PatchWS-ModifyPeripheralMaterialintegration/api/odata/MousePeripheralMaterials({key})
DeleteWS-ModifyPeripheralMaterialintegration/api/odata/MousePeripheralMaterials({key})

Key(s)
MaterialID

MousePeripheralMaterial Structural Properties

No structural properties

MousePeripheralMaterial Navigational Properties

No navigational properties


MoveAssetControl Entity : FormControl

Verb(s)Required Permission(s)LinkDescription

Key(s)
ID

MoveAssetControl Structural Properties

No structural properties

MoveAssetControl Navigational Properties

No navigational properties


MoveAssetControlValue Entity : FormInstanceControlValue

Verb(s)Required Permission(s)LinkDescription

Key(s)
ID

MoveAssetControlValue Structural Properties

PropertyTypeNullableMandatoryRead-OnlyString lengthMin ValueMax ValuePrecisionMax Dec PlacesIs Only DateDescription
ProcessedAssetIDsCollection(Edm.Int32)falsefalse false N/AN/AN/AN/AN/A

MoveAssetControlValue Navigational Properties

No navigational properties


NameConvention Entity - Naming conventions are defined for different entity types, to be used to assign generated asset names

Verb(s)Required Permission(s)LinkDescription

Key(s)
ConventionID

NameConvention Structural Properties

PropertyTypeNullableMandatoryRead-OnlyString lengthMin ValueMax ValuePrecisionMax Dec PlacesIs Only DateDescription
ConventionIDEdm.Int32falsefalse false N/AN/AN/AN/AN/A
ConventionNameEdm.Stringfalsetrue false 30N/AN/AN/AN/A
ConventionSetIDEdm.Int32falsefalse false N/AN/AN/AN/AN/A
CounterEdm.Int32truefalse false N/AN/AN/AN/AN/A
LocationGroupIDEdm.Int32truefalse false N/AN/AN/AN/AN/AForeign key identifying the asset location
NamingStandardEdm.Stringfalsetrue false 15N/AN/AN/AN/A
SeedEdm.Int32falsefalse false N/AN/AN/AN/AN/A
SuffixSizeEdm.Int16falsefalse false N/AN/AN/AN/AN/A

NameConvention Navigational Properties

No navigational properties


NameConventionSet Entity - Category that manages naming conventions

Verb(s)Required Permission(s)LinkDescription

Key(s)
ConventionSetID

NameConventionSet Structural Properties

PropertyTypeNullableMandatoryRead-OnlyString lengthMin ValueMax ValuePrecisionMax Dec PlacesIs Only DateDescription
ConventionSetIDEdm.Int32falsefalse false N/AN/AN/AN/AN/A
ConventionSetNameEdm.Stringfalsetrue false 50N/AN/AN/AN/A
EntityTypeIDEdm.Int32falsefalse false N/AN/AN/AN/AN/AThe type being Chassis, Cabinet, Server, Host
LocationGroupIDEdm.Int32truefalse false N/AN/AN/AN/AN/AForeign key identifying the asset location

NameConventionSet Navigational Properties

No navigational properties


NavigatorAsset Entity

Verb(s)Required Permission(s)LinkDescription
GetWS-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-ReadChassisMountedAssetMapintegration/api/odata/NavigatorAssets({key}), integration/api/odata/NavigatorAssets

Key(s)
AssetID

NavigatorAsset Structural Properties

PropertyTypeNullableMandatoryRead-OnlyString lengthMin ValueMax ValuePrecisionMax Dec PlacesIs Only DateDescription
AssetIDEdm.Int32truefalse false N/AN/AN/AN/AN/A
AssetNameEdm.Stringtruefalse false N/AN/AN/AN/AN/A
AssetNumberEdm.Int32falsefalse false N/AN/AN/AN/AN/A
AssetOperationalStatusIDNlyte.Model.OperationalStatusEnumfalsefalse true N/AN/AN/AN/AN/A
CabinetAssetIDEdm.Int32truefalse true N/AN/AN/AN/AN/A
ChassisAssetIDEdm.Int32truefalse true N/AN/AN/AN/AN/A
HasChildrenEdm.Booleanfalsefalse false N/AN/AN/AN/AN/A
LocationGroupIDEdm.Int32falsefalse true N/AN/AN/AN/AN/A
MaterialSubTypeEdm.Stringtruefalse true N/AN/AN/AN/AN/A
MaterialSubtypeIDEdm.Int32falsefalse true N/AN/AN/AN/AN/A
MaterialTypeEdm.Stringtruefalse true N/AN/AN/AN/AN/A
MaterialTypeIDEdm.Int32falsefalse true N/AN/AN/AN/AN/A
ParentIDEdm.Int32truefalse false N/AN/AN/AN/AN/A
ParentLocationGroupIDEdm.Int32truefalse true N/AN/AN/AN/AN/A
RecordStatusNlyte.Model.RecordStatusEnumfalsefalse true N/AN/AN/AN/AN/A

NavigatorAsset Navigational Properties

PropertyType
AssetNlyte.Model.Asset
ServerHostNlyte.Model.ServerHost



Network Entity : Asset - Asset created from a material of type network, entity inheriting the Nlyte.Model.Asset entity

Verb(s)Required Permission(s)LinkDescription
GetWS-ReadNetworkintegration/api/odata/Networks, integration/api/odata/Networks({key})
DeleteWS-ModifyNetworkintegration/api/odata/Networks({key})
PatchWS-ModifyNetworkintegration/api/odata/Networks({key})
PostWithKeyWS-ModifyNetworkintegration/api/odata/Networks({key})
PostWS-AddNetworkintegration/api/odata/Networks

Key(s)
AssetID

Network Structural Properties

PropertyTypeNullableMandatoryRead-OnlyString lengthMin ValueMax ValuePrecisionMax Dec PlacesIs Only DateDescription
AuditDateEdm.DateTimeOffsettruefalse false N/AN/AN/AN/AN/A
AuditStatusCorrectEdm.Booleantruefalse false N/AN/AN/AN/AN/A
CabinetPositionNlyte.Model.CabinetPositionEnumtruefalse false N/AN/AN/AN/AN/A
CardPositionEdm.Stringtruefalse false 20N/AN/AN/AN/AProperty used by network cards.
ChassisMountedAssetMapIDEdm.Int32truefalse true N/AN/AN/AN/AN/A
HostingAssetIDEdm.Int32truefalse true N/AN/AN/AN/AN/A
LastAuditorAccountIDEdm.Int32truefalse false N/AN/AN/AN/AN/A
NetworkUsageIDEdm.Int32truefalse false N/AN/AN/AN/AN/A
PointTypeNlyte.Model.PointTypeEnumtruefalse false N/AN/AN/AN/AN/A
RoomOrientationNlyte.Model.RoomOrientationEnumtruefalse false N/AN/AN/AN/AN/A
TotalPlugsEdm.Int32falsefalse true N/AN/AN/AN/AN/A
UnitsNlyte.Model.UnitsEnumtruefalse false N/AN/AN/AN/AN/A

Network Navigational Properties

PropertyType
ChassisMountedAssetMapNlyte.Model.ChassisMountedAssetMap
HostingAssetNlyte.Model.Asset
InputConnectorsCollection(Nlyte.Model.InputConnector)
NetworkMaterialNlyte.Model.NetworkMaterial
NetworkPortsCollection(Nlyte.Model.NetworkPort)
NetworkUsageNlyte.Model.NetworkUsage
PeripheralsCollection(Nlyte.Model.PeripheralAssetLink)



NetworkCableType Entity

Verb(s)Required Permission(s)LinkDescription

Key(s)
NetworkCableTypeID

NetworkCableType Structural Properties

PropertyTypeNullableMandatoryRead-OnlyString lengthMin ValueMax ValuePrecisionMax Dec PlacesIs Only DateDescription
DetailEdm.Stringfalsetrue false 30N/AN/AN/AN/A
NetworkCableTypeIDEdm.Int32falsefalse false N/AN/AN/AN/AN/A

NetworkCableType Navigational Properties

No navigational properties


NetworkCardPortName Entity

Verb(s)Required Permission(s)LinkDescription

Key(s)
NetworkCardPortNameID

NetworkCardPortName Structural Properties

PropertyTypeNullableMandatoryRead-OnlyString lengthMin ValueMax ValuePrecisionMax Dec PlacesIs Only DateDescription
DetailEdm.Stringfalsetrue false 40N/AN/AN/AN/A
NetworkCardPortNameIDEdm.Int32falsefalse false N/AN/AN/AN/AN/A

NetworkCardPortName Navigational Properties

No navigational properties


NetworkConnectorType Entity

Verb(s)Required Permission(s)LinkDescription

Key(s)
NetworkConnectorTypeID

NetworkConnectorType Structural Properties

PropertyTypeNullableMandatoryRead-OnlyString lengthMin ValueMax ValuePrecisionMax Dec PlacesIs Only DateDescription
DetailEdm.Stringfalsetrue false 30N/AN/AN/AN/A
NetworkConnectorTypeIDEdm.Int32falsefalse false N/AN/AN/AN/AN/A

NetworkConnectorType Navigational Properties

No navigational properties


NetworkGraph Entity

Verb(s)Required Permission(s)LinkDescription
GetWS-ReadNetworkConnectionintegration/api/odata/NetworkGraphs, integration/api/odata/NetworkGraphs({key})
PostWS-AddNetworkConnectionintegration/api/odata/NetworkGraphs
PostWithKeyWS-ModifyNetworkConnectionintegration/api/odata/NetworkGraphs({key})
PatchWS-ModifyNetworkConnection
DeleteWS-ModifyNetworkConnection

Key(s)
NetworkGraphID

NetworkGraph Structural Properties

PropertyTypeNullableMandatoryRead-OnlyString lengthMin ValueMax ValuePrecisionMax Dec PlacesIs Only DateDescription
ConnectionColorEdm.Int32true false
ConnectionLengthEdm.Decimaltrue false
ConnectionNameEdm.Stringtrue false
ConnectionPortStatusNlyte.Model.PortStatetruetrue false N/AN/AN/AN/AN/A
ConnectionTrunkNameEdm.Stringtrue false
ConnectionTypeEdm.Int32true false
DestinationPortLocationNlyte.Model.PortLocationfalse false
NetworkGraphIDEdm.Int32falsefalse false N/AN/AN/AN/AN/A
PortEndNodeIDEdm.Int32truetrue false N/AN/AN/AN/AN/A
PortStartNodeIDEdm.Int32truetrue false N/AN/AN/AN/AN/A
SourcePortLocationNlyte.Model.PortLocationfalse false

NetworkGraph Navigational Properties

PropertyType
NetworkCableTypeNlyte.Model.NetworkCableType
PortEndNodeNlyte.Model.NetworkPort
PortStartNodeNlyte.Model.NetworkPort



NetworkMaterial Entity : Material - Material type inheriting properties from the base type

Verb(s)Required Permission(s)LinkDescription
GetWS-ReadNetworkMaterialintegration/api/odata/NetworkMaterials, integration/api/odata/NetworkMaterials({key})
PostWS-AddNetworkMaterialintegration/api/odata/NetworkMaterials
PostWithKeyWS-ModifyNetworkMaterialintegration/api/odata/NetworkMaterials({key})
PatchWS-ModifyNetworkMaterialintegration/api/odata/NetworkMaterials({key})
DeleteWS-ModifyNetworkMaterialintegration/api/odata/NetworkMaterials({key})

Key(s)
MaterialID

NetworkMaterial Structural Properties

PropertyTypeNullableMandatoryRead-OnlyString lengthMin ValueMax ValuePrecisionMax Dec PlacesIs Only DateDescription
IsSuppliedMaterialUpdatedEdm.Booleanfalsefalse true N/AN/AN/AN/AN/Aread-only property, set to true when a user modifies NetworkMaterialPorts
MaterialSubtypeIDEdm.Int32truefalse true N/AN/AN/AN/AN/A
MountingTypeIDNlyte.Model.MountingTypeEnumtruefalse false N/AN/AN/AN/AN/A
NetworkSpeedMbpsEdm.Int32truefalse false N/AN/AN/AN/AN/ANetwork speed in Mbps
StandardCopperPortsEdm.Int32truefalse false N/AN/AN/AN/AN/A
StandardFiberOpticPortsEdm.Int32truefalse false N/AN/AN/AN/AN/A
TotalCopperPortsEdm.Int32truefalse true N/AN/AN/AN/AN/A
TotalFiberOpticPortsEdm.Int32truefalse true N/AN/AN/AN/AN/A
TotalPlugsEdm.Int32truefalse false N/AN/AN/AN/AN/AValue inserted by the user, while the material is in Planned status
TotalUndefinedPortsEdm.Int32true false
UHeightEdm.Int64falsefalse true N/AN/AN/AN/AN/A

NetworkMaterial Navigational Properties

PropertyType
NetworkMaterialPortsCollection(Nlyte.Model.NetworkMaterialPort)



NetworkMaterialPort Entity

Verb(s)Required Permission(s)LinkDescription
GetWS-ReadNetworkMaterial
PatchWS-ModifyNetworkMaterial
PostWithKeyWS-ModifyNetworkMaterial

Key(s)
ID

NetworkMaterialPort Structural Properties

PropertyTypeNullableMandatoryRead-OnlyString lengthMin ValueMax ValuePrecisionMax Dec PlacesIs Only DateDescription
DefaultInternalPortNameEdm.Stringtruefalse true 50N/AN/AN/AN/A
DefaultPortNameEdm.Stringtruefalse true 50N/AN/AN/AN/A
IDEdm.Int32falsetrue false N/AN/AN/AN/AN/A
NetworkMaterialIDEdm.Int32falsefalse true N/AN/AN/AN/AN/A
NetworkMaterialPortGroupMapIDEdm.Int32truefalse false N/AN/AN/AN/AN/A
NewInternalPortNameEdm.Stringtruefalse true 50N/AN/AN/AN/A
NewPortNameEdm.Stringtruefalse true 50N/AN/AN/AN/A
PortTypeNlyte.Model.NetworkPortTypeEnumfalse false

NetworkMaterialPort Navigational Properties

PropertyType
NetworkMaterialNlyte.Model.NetworkMaterial
NetworkMaterialPortGroupMapNlyte.Model.NetworkMaterialPortGroupMap



NetworkMaterialPortGroup Entity

Verb(s)Required Permission(s)LinkDescription
GetWS-ReadNetworkMaterial
PatchWS-ModifyNetworkMaterial
PostWithKeyWS-ModifyNetworkMaterial

Key(s)
NetworkMaterialPortGroupID

NetworkMaterialPortGroup Structural Properties

PropertyTypeNullableMandatoryRead-OnlyString lengthMin ValueMax ValuePrecisionMax Dec PlacesIs Only DateDescription
DefaultPortGroupNameEdm.Stringtruefalse true 50N/AN/AN/AN/A
NetworkMaterialPortGroupIDEdm.Int32falsetrue false N/AN/AN/AN/AN/A
NetworkPortGroupTypeIDNlyte.Model.NetworkPortGroupTypeEnumfalsetrue false N/AN/AN/AN/AN/A
NewPortGroupNameEdm.Stringtruefalse true 50N/AN/AN/AN/A

NetworkMaterialPortGroup Navigational Properties

No navigational properties


NetworkMaterialPortGroupMap Entity

Verb(s)Required Permission(s)LinkDescription
GetWS-ReadNetworkMaterial
PatchWS-ModifyNetworkMaterial
PostWithKeyWS-ModifyNetworkMaterial
DeleteWS-ModifyNetworkMaterial

Key(s)
NetworkMaterialPortGroupMapID

NetworkMaterialPortGroupMap Structural Properties

PropertyTypeNullableMandatoryRead-OnlyString lengthMin ValueMax ValuePrecisionMax Dec PlacesIs Only DateDescription
NetworkMaterialIDEdm.Int32falsefalse false N/AN/AN/AN/AN/A
NetworkMaterialInternalPortGroupIDEdm.Int32truefalse false N/AN/AN/AN/AN/A
NetworkMaterialPortGroupIDEdm.Int32truefalse false N/AN/AN/AN/AN/A
NetworkMaterialPortGroupMapIDEdm.Int32falsetrue false N/AN/AN/AN/AN/A

NetworkMaterialPortGroupMap Navigational Properties

PropertyType
InternalPortGroupNlyte.Model.NetworkMaterialPortGroup
NetworkMaterialNlyte.Model.NetworkMaterial
PortGroupNlyte.Model.NetworkMaterialPortGroup



NetworkPort Entity - Provides information about a network port

Verb(s)Required Permission(s)LinkDescription
GetWS-ReadNetworkConnectionintegration/api/odata/NetworkPorts, integration/api/odata/NetworkPorts({key})
PatchWS-ModifyNetworkConnection
PostWithKeyWS-ModifyNetworkConnection

Key(s)
NetworkPortID

NetworkPort Structural Properties

PropertyTypeNullableMandatoryRead-OnlyString lengthMin ValueMax ValuePrecisionMax Dec PlacesIs Only DateDescription
ConnectorTypeIDEdm.Int32truefalse false N/AN/AN/AN/AN/A
DataTypeIDEdm.Int32truefalse false N/AN/AN/AN/AN/A
InternalConnectorTypeIDEdm.Int32truefalse false N/AN/AN/AN/AN/A
InternalPortNameEdm.Stringtruefalse false 50N/AN/AN/AN/ANetwork Port Name (back). This must be unique per device.
InternalPortStateIDNlyte.Model.PortStatetruefalse false N/AN/AN/AN/AN/AConnected or free
LocationGroupIDEdm.Int32truefalse false N/AN/AN/AN/AN/AForeign key identifying the asset location
NetworkAssetIDEdm.Int32falsefalse true N/AN/AN/AN/AN/A
NetworkInternalPortGroupIDEdm.Int32truefalse true N/AN/AN/AN/AN/A
NetworkPortGroupIDEdm.Int32truefalse true N/AN/AN/AN/AN/A
NetworkPortIDEdm.Int32falsetrue false N/AN/AN/AN/AN/A
PhysicalAddressEdm.Stringtruefalse false 50N/AN/AN/AN/A
PortNameEdm.Stringtruefalse false 50N/AN/AN/AN/ANetwork Port Name (front). This must be unique per device.
PortSpeedIDEdm.Int32truefalse false N/AN/AN/AN/AN/A
PortStateIDNlyte.Model.PortStatefalsefalse false N/AN/AN/AN/AN/AConnected or free
PortTypeIDNlyte.Model.NetworkPortTypeEnumfalsefalse false N/AN/AN/AN/AN/A

NetworkPort Navigational Properties

PropertyType
LocationGroupNlyte.Model.LocationGroup
NetworkNlyte.Model.Network
NetworkConnectorTypeNlyte.Model.NetworkConnectorType
NetworkGraphsCollection(Nlyte.Model.NetworkGraph)
NetworkInternalConnectorTypeNlyte.Model.NetworkConnectorType
NetworkInternalPortGroupNlyte.Model.NetworkPortGroup
NetworkPortAssetIPAddressMapsCollection(Nlyte.Model.NetworkPortAssetIPAddressMap)
NetworkPortDataTypeNlyte.Model.NetworkPortDataType
NetworkPortGroupNlyte.Model.NetworkPortGroup
NetworkPortServerHostIPAddressMapsCollection(Nlyte.Model.NetworkPortServerHostIPAddressMap)
NetworkSpeedNlyte.Model.NetworkSpeed
NotesCollection(Nlyte.Model.NetworkPortNote)
ServiceProviderNlyte.Model.NetworkPortServiceProvider



NetworkPortAssetIPAddressMap Entity

Verb(s)Required Permission(s)LinkDescription
GetWS-ReadNetworkConnection
PostWS-AddNetworkConnection
PatchWS-ModifyNetworkConnection
PostWithKeyWS-ModifyNetworkConnection
DeleteWS-ModifyNetworkConnection

Key(s)
ID

NetworkPortAssetIPAddressMap Structural Properties

PropertyTypeNullableMandatoryRead-OnlyString lengthMin ValueMax ValuePrecisionMax Dec PlacesIs Only DateDescription
IDEdm.Int32falsefalse false N/AN/AN/AN/AN/A
IPAddressIDEdm.Int32truefalse false N/AN/AN/AN/AN/A
NetworkPortIDEdm.Int32truefalse false N/AN/AN/AN/AN/A

NetworkPortAssetIPAddressMap Navigational Properties

PropertyType
IPAddressNlyte.Model.IPAddress
NetworkPortNlyte.Model.NetworkPort



NetworkPortConnection Entity

Verb(s)Required Permission(s)LinkDescription

Key(s)
StartNodePortID

NetworkPortConnection Structural Properties

PropertyTypeNullableMandatoryRead-OnlyString lengthMin ValueMax ValuePrecisionMax Dec PlacesIs Only DateDescription
ConnectionColourIDEdm.Int32truefalse false N/AN/AN/AN/AN/A
ConnectionLengthEdm.Decimaltruefalse false N/AN/AN/AN/AN/A
ConnectionNameEdm.Stringtruefalse false N/AN/AN/AN/AN/A
ConnectionTrunkNameEdm.Stringtruefalse false N/AN/AN/AN/AN/A
ConnectionTypeEdm.Stringtruefalse false N/AN/AN/AN/AN/A
EndNodeAssetIDEdm.Int32truefalse false N/AN/AN/AN/AN/A
EndNodeAssetNameEdm.Stringtruefalse false N/AN/AN/AN/AN/A
EndNodeAssetNumberEdm.Int32truefalse false N/AN/AN/AN/AN/A
EndNodeAssetRecordStatusNlyte.Model.RecordStatusEnumtruefalse false N/AN/AN/AN/AN/A
EndNodeAssetTypeEdm.Stringtruefalse false N/AN/AN/AN/AN/ADestination asset Material type
EndNodeConnectorTypeEdm.Stringtruefalse false N/AN/AN/AN/AN/A
EndNodeDataTypeEdm.Stringtruefalse false N/AN/AN/AN/AN/A
EndNodePortGroupIDEdm.Int32truefalse false N/AN/AN/AN/AN/A
EndNodePortGroupNameEdm.Stringtruefalse false N/AN/AN/AN/AN/A
EndNodePortGroupStatusNlyte.Model.PortStatetruefalse false N/AN/AN/AN/AN/A
EndNodePortGroupTypeNlyte.Model.NetworkPortGroupTypeEnumtruefalse false N/AN/AN/AN/AN/A
EndNodePortIDEdm.Int32truefalse false N/AN/AN/AN/AN/A
EndNodePortLocationEdm.Stringtruefalse false N/AN/AN/AN/AN/A
EndNodePortNameEdm.Stringtruefalse false N/AN/AN/AN/AN/A
EndNodePortStateNlyte.Model.PortStatetruefalse false N/AN/AN/AN/AN/AConnected or free
EndNodePortTypeNlyte.Model.NetworkPortTypeEnumtruefalse false N/AN/AN/AN/AN/A
HasNavEdm.Booleanfalsefalse false N/AN/AN/AN/AN/A
HasNotesEdm.Booleanfalsefalse false N/AN/AN/AN/AN/A
IsAccessibleEdm.Booleanfalsefalse false N/AN/AN/AN/AN/A
IsProperPortGroupConnectionEdm.Booleanfalsefalse false N/AN/AN/AN/AN/A
NetworkGraphIDEdm.Int32truefalse false N/AN/AN/AN/AN/A
NoteCountEdm.Int32falsefalse false N/AN/AN/AN/AN/A
StartNodeAssetIDEdm.Int32falsefalse false N/AN/AN/AN/AN/A
StartNodeAssetNameEdm.Stringtruefalse false N/AN/AN/AN/AN/A
StartNodeAssetNumberEdm.Int32falsefalse false N/AN/AN/AN/AN/A
StartNodeAssetRecordStatusNlyte.Model.RecordStatusEnumtruefalse false N/AN/AN/AN/AN/A
StartNodeConnectorTypeEdm.Stringtruefalse false N/AN/AN/AN/AN/A
StartNodeDataTypeEdm.Stringtruefalse false N/AN/AN/AN/AN/A
StartNodeHostNameEdm.Stringtruefalse false N/AN/AN/AN/AN/A
StartNodeIPAddressesEdm.Stringtruefalse false N/AN/AN/AN/AN/A
StartNodeMACAddressEdm.Stringtruefalse false N/AN/AN/AN/AN/A
StartNodePortGroupIDEdm.Int32truefalse false N/AN/AN/AN/AN/A
StartNodePortGroupNameEdm.Stringtruefalse false N/AN/AN/AN/AN/A
StartNodePortGroupStatusNlyte.Model.PortStatetruefalse false N/AN/AN/AN/AN/A
StartNodePortGroupTypeNlyte.Model.NetworkPortGroupTypeEnumtruefalse false N/AN/AN/AN/AN/A
StartNodePortIDEdm.Int32falsefalse false N/AN/AN/AN/AN/A
StartNodePortNameEdm.Stringtruefalse false N/AN/AN/AN/AN/A
StartNodePortSpeedEdm.Stringtruefalse false N/AN/AN/AN/AN/A
StartNodePortStateNlyte.Model.PortStatefalsefalse false N/AN/AN/AN/AN/AConnected or free
StartNodePortTypeNlyte.Model.NetworkPortTypeEnumtruefalse false N/AN/AN/AN/AN/A

NetworkPortConnection Navigational Properties

No navigational properties


NetworkPortDataType Entity

Verb(s)Required Permission(s)LinkDescription

Key(s)
NetworkPortDataTypeID

NetworkPortDataType Structural Properties

PropertyTypeNullableMandatoryRead-OnlyString lengthMin ValueMax ValuePrecisionMax Dec PlacesIs Only DateDescription
DetailEdm.Stringfalsetrue false 40N/AN/AN/AN/A
NetworkPortDataTypeIDEdm.Int32falsefalse false N/AN/AN/AN/AN/A

NetworkPortDataType Navigational Properties

No navigational properties


NetworkPortGroup Entity

Verb(s)Required Permission(s)LinkDescription
GetWS-ReadNetworkConnectionintegration/api/odata/NetworkPortGroups, integration/api/odata/NetworkPortGroups({key})
PatchWS-ModifyNetworkConnectionintegration/api/odata/NetworkPortGroups({key})
PostWithKeyWS-ModifyNetworkConnectionintegration/api/odata/NetworkPortGroups({key})

Key(s)
NetworkPortGroupID

NetworkPortGroup Structural Properties

PropertyTypeNullableMandatoryRead-OnlyString lengthMin ValueMax ValuePrecisionMax Dec PlacesIs Only DateDescription
NetworkPortGroupConnectorTypeIDEdm.Int32truefalse true N/AN/AN/AN/AN/AConnector Type of the group's sub-ports. GET returns no data because the data is not saved for NetworkPortGroup entity.
NetworkPortGroupDataTypeIDEdm.Int32truefalse true N/AN/AN/AN/AN/AData Type of the group's sub-ports. GET returns no data because the data is not saved for NetworkPortGroup entity.
NetworkPortGroupIDEdm.Int32falsefalse true N/AN/AN/AN/AN/A
NetworkPortGroupNameEdm.Stringtruetrue true 50N/AN/AN/AN/A
NetworkPortGroupPhysicalAddressEdm.Stringtruefalse true 50N/AN/AN/AN/APhysical Address of the sub-ports. GET returns no data because the data is not saved for NetworkPortGroup entity.
NetworkPortGroupPortTypeIDNlyte.Model.NetworkPortTypeEnumtruefalse true N/AN/AN/AN/AN/APort Type of the sub-ports. GET returns no data because the data is not saved for NetworkPortGroup entity.
NetworkPortGroupSpeedIDEdm.Int32truefalse true N/AN/AN/AN/AN/ASpeed of the group's sub-ports. GET returns no data because the data is not saved for NetworkPortGroup entity.
NetworkPortGroupStateIDNlyte.Model.PortStatetruefalse true N/AN/AN/AN/AN/APort State of the sub-ports
NetworkPortGroupTypeIDNlyte.Model.NetworkPortGroupTypeEnumfalsefalse false N/AN/AN/AN/AN/A

NetworkPortGroup Navigational Properties

PropertyType
NetworkPortGroupAssetIPAddressMapsCollection(Nlyte.Model.NetworkPortGroupAssetIPAddressMap)
NetworkPortGroupServerHostIPAddressMapsCollection(Nlyte.Model.NetworkPortGroupServerHostIPAddressMap)



NetworkPortGroupAssetIPAddressMap Entity - Entity providing details for the Groups Asset IP Addresses

Verb(s)Required Permission(s)LinkDescription

Key(s)
NetworkPortAssetIPAddressMapID

NetworkPortGroupAssetIPAddressMap Structural Properties

PropertyTypeNullableMandatoryRead-OnlyString lengthMin ValueMax ValuePrecisionMax Dec PlacesIs Only DateDescription
NetworkPortAssetIPAddressMapIDEdm.Int32truefalse false N/AN/AN/AN/AN/A
NetworkPortGroupIDEdm.Int32falsefalse false N/AN/AN/AN/AN/A

NetworkPortGroupAssetIPAddressMap Navigational Properties

PropertyType
NetworkPortAssetIPAddressMapNlyte.Model.NetworkPortAssetIPAddressMap



NetworkPortGroupServerHostIPAddressMap Entity - Entity providing details for the Groups Server Host IP Addresses

Verb(s)Required Permission(s)LinkDescription

Key(s)
NetworkPortServerHostIPAddressMapID

NetworkPortGroupServerHostIPAddressMap Structural Properties

PropertyTypeNullableMandatoryRead-OnlyString lengthMin ValueMax ValuePrecisionMax Dec PlacesIs Only DateDescription
NetworkPortGroupIDEdm.Int32falsefalse false N/AN/AN/AN/AN/A
NetworkPortServerHostIPAddressMapIDEdm.Int32truefalse false N/AN/AN/AN/AN/A

NetworkPortGroupServerHostIPAddressMap Navigational Properties

PropertyType
NetworkPortServerHostIPAddressMapNlyte.Model.NetworkPortServerHostIPAddressMap



NetworkPortGroupType Entity

Verb(s)Required Permission(s)LinkDescription
GetWS-ReadNetworkConnectionintegration/api/odata/NetworkPortGroupTypes, integration/api/odata/NetworkPortGroupTypes({key})
PatchWS-ModifyNetworkConnection
PostWithKeyWS-ModifyNetworkConnection

Key(s)
NetworkPortGroupTypeID

NetworkPortGroupType Structural Properties

PropertyTypeNullableMandatoryRead-OnlyString lengthMin ValueMax ValuePrecisionMax Dec PlacesIs Only DateDescription
DetailEdm.Stringtruetrue false 30N/AN/AN/AN/A
NetworkPortGroupTypeIDEdm.Int32falsetrue false N/AN/AN/AN/AN/A
TotalCopperPortsEdm.Int32truefalse false N/AN/AN/AN/AN/A
TotalFibreOpticPortsEdm.Int32truefalse false N/AN/AN/AN/AN/A

NetworkPortGroupType Navigational Properties

No navigational properties


NetworkPortNote Entity : Note

Verb(s)Required Permission(s)LinkDescription
PostWS-AddNote
PatchWS-ModifyNote
DeleteWS-ModifyNote
GetWS-ReadNote

Key(s)
NoteID

NetworkPortNote Structural Properties

No structural properties

NetworkPortNote Navigational Properties

No navigational properties


NetworkPortServerHostIPAddressMap Entity

Verb(s)Required Permission(s)LinkDescription
GetWS-ReadNetworkConnection
PatchWS-ModifyNetworkConnection
DeleteWS-ModifyNetworkConnection
PostWS-AddNetworkConnection
PostWithKeyWS-ModifyNetworkConnection

Key(s)
ID

NetworkPortServerHostIPAddressMap Structural Properties

PropertyTypeNullableMandatoryRead-OnlyString lengthMin ValueMax ValuePrecisionMax Dec PlacesIs Only DateDescription
IDEdm.Int32falsefalse false N/AN/AN/AN/AN/A
IPAddressIDEdm.Int32truefalse false N/AN/AN/AN/AN/A
NetworkPortIDEdm.Int32truefalse false N/AN/AN/AN/AN/A
ServerHostIDEdm.Int32truefalse false N/AN/AN/AN/AN/A

NetworkPortServerHostIPAddressMap Navigational Properties

PropertyType
IPAddressNlyte.Model.IPAddress
NetworkPortNlyte.Model.NetworkPort
ServerHostNlyte.Model.ServerHost



NetworkPortServiceProvider Entity - Provides information about a network port

Verb(s)Required Permission(s)LinkDescription

Key(s)
NetworkPortID

NetworkPortServiceProvider Structural Properties

PropertyTypeNullableMandatoryRead-OnlyString lengthMin ValueMax ValuePrecisionMax Dec PlacesIs Only DateDescription
AActlClliCodeEdm.Stringtruefalse false 255N/AN/AN/AN/AAccess 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 .
ACfaLoaLocationEdm.Stringtruefalse false 255N/AN/AN/AN/AChannel 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
ACrossConnectOrderedLocationEdm.Stringtruefalse false 255N/AN/AN/AN/AThis is to track if a connection has been ordered
AMonthlyLocalLoopCircuitCostEdm.Decimaltruefalse false N/A099999999999.99132The monthly cost of the A local circuit
ATotalMonthlyRecurringCostEdm.Decimaltruefalse false N/A099999999999.99132The total monthly cost of the local circuit
BillingIDEdm.Stringtruefalse false 255N/AN/AN/AN/ABilling code for the Circuit
BusinessUnitIDEdm.Stringtruefalse false 255N/AN/AN/AN/AThis is to track the business unit assigned to a port
CircuitAcceptanceDateEdm.DateTimeOffsettruefalse false N/AN/AN/AN/AN/AIsOnlyDateThe acceptance date
CircuitContractEndDateEdm.DateTimeOffsettruefalse false N/AN/AN/AN/AN/AIsOnlyDateThe date the circuits service contractual obligation ends
CircuitContractStartDateEdm.DateTimeOffsettruefalse false N/AN/AN/AN/AN/AIsOnlyDateThe contract date to start the service
CircuitDecommissionCodeEdm.Stringtruefalse false 255N/AN/AN/AN/AInternal business code for tracking circuits that have been decommissioned
CircuitDecommissionDateEdm.DateTimeOffsettruefalse false N/AN/AN/AN/AN/AIsOnlyDateThe date the circuit service is turned off
CircuitProjectIDEdm.Stringtruefalse false 255N/AN/AN/AN/AThe project that the circuit is requested under
CircuitQuoteIDEdm.Stringtruefalse false 255N/AN/AN/AN/AThe ID of the vendor service quote
CircuitServiceIDEdm.Stringtruefalse false 255N/AN/AN/AN/Atracking the service offering ID number
ClientIDEdm.Stringtruefalse false 255N/AN/AN/AN/AThis is to track the business units client assigned to a port
ClientNameEdm.Stringtruefalse false 255N/AN/AN/AN/AThis is to track the business units client assigned to a port
ConfirmedWithAccountingEdm.Stringtruefalse false 255N/AN/AN/AN/AConfirmed with accounting
CustomerLoaEdm.Stringtruefalse false 255N/AN/AN/AN/ALetter of authority (LOA) provides permission to create a connection to and from the provider
DecommissionVendorIDEdm.Stringtruefalse false 255N/AN/AN/AN/AFor tracking the 3rd party decommissioning a circuit
InterconnectRefNumberEdm.Stringtruefalse false 255N/AN/AN/AN/Ainterconnect vendor reference number
MonthlyInterconnectFeeEdm.Decimaltruefalse false N/A099999999999.99132The monthly cost for the interconnect
MonthlyTariffsEdm.Decimaltruefalse false N/A099999999999.99132The TAX cost of the local circuit
MsaContractExpirationDateEdm.DateTimeOffsettruefalse false N/AN/AN/AN/AN/AIsOnlyDateThe master services agreement contract number with the vendor
MsaContractNumberEdm.Stringtruefalse false 255N/AN/AN/AN/AThe master services agreement contract number with the vendor
NetworkPortIDEdm.Int32truefalse true N/AN/AN/AN/AN/A
PoNumberEdm.Stringtruefalse false 255N/AN/AN/AN/APO number
ProductLineEdm.Stringtruefalse false 255N/AN/AN/AN/ATracking the service offering
ProjectNameEdm.Stringtruefalse false 255N/AN/AN/AN/AThis is the project for the new port
RenewalCircuitEdm.Stringtruefalse false 255N/AN/AN/AN/ATracking if the service is a renewal service Yes or no
RequisitionNumberEdm.Stringtruefalse false 255N/AN/AN/AN/AThis is the requisition number for the new circuit
SavingsCodeEdm.Stringtruefalse false 255N/AN/AN/AN/AFor tracking a cost center
VendorAccountNumberEdm.Stringtruefalse false 255N/AN/AN/AN/AVendor provided billing account number
VendorCircuitIDEdm.Stringtruefalse false 255N/AN/AN/AN/AVendor provided circuit ID for tracking
VendorCircuitStatusEdm.Stringtruefalse false 255N/AN/AN/AN/AThe circuit if active or decommissioned
VendorCircuitTypeEdm.Stringtruefalse false 255N/AN/AN/AN/AThe type of service provided by the vendor
VendorNameEdm.Stringtruefalse false 255N/AN/AN/AN/AThe name of the service provider (vendor)
VendorOrderNumberEdm.Stringtruefalse false 255N/AN/AN/AN/AThe ID of the vendor order number
ZActlClliCodeEdm.Stringtruefalse false 255N/AN/AN/AN/AAccess 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.
ZCfaLoaLocationEdm.Stringtruefalse false 255N/AN/AN/AN/AChannel 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.
ZCrossConnectOrderedLocationEdm.Stringtruefalse false 255N/AN/AN/AN/AThis is to track if a connection has been ordered
ZMonthlyLocalLoopCircuitCostEdm.Decimaltruefalse false N/A099999999999.99132The monthly cost of the Z local loop/circuit
ZTotalMonthlyRecurringCostEdm.Decimaltruefalse false N/A099999999999.99132The total monthly cost of the local circuit

NetworkPortServiceProvider Navigational Properties

PropertyType
NetworkPortNlyte.Model.NetworkPort



NetworkSpeed Entity

Verb(s)Required Permission(s)LinkDescription

Key(s)
NetworkSpeedID

NetworkSpeed Structural Properties

PropertyTypeNullableMandatoryRead-OnlyString lengthMin ValueMax ValuePrecisionMax Dec PlacesIs Only DateDescription
DetailEdm.Int64falsefalse false N/AN/AN/AN/AN/A
NetworkSpeedIDEdm.Int32falsefalse false N/AN/AN/AN/AN/A

NetworkSpeed Navigational Properties

No navigational properties


NetworkUsage Entity

Verb(s)Required Permission(s)LinkDescription

Key(s)
NetworkUsageID

NetworkUsage Structural Properties

PropertyTypeNullableMandatoryRead-OnlyString lengthMin ValueMax ValuePrecisionMax Dec PlacesIs Only DateDescription
DetailEdm.Stringfalsetrue false 30N/AN/AN/AN/A
NetworkUsageIDEdm.Int32falsefalse false N/AN/AN/AN/AN/A

NetworkUsage Navigational Properties

No navigational properties


Note Entity

Verb(s)Required Permission(s)LinkDescription
PostWS-AddNote
PatchWS-ModifyNote
DeleteWS-ModifyNote
GetWS-ReadNote

Key(s)
NoteID

Note Structural Properties

PropertyTypeNullableMandatoryRead-OnlyString lengthMin ValueMax ValuePrecisionMax Dec PlacesIs Only DateDescription
BodyEdm.Stringfalsetrue false 800N/AN/AN/AN/A
DateTimeStampEdm.DateTimeOffsettruefalse true N/AN/AN/AN/AN/A
EntityIDEdm.Int32falsefalse true N/AN/AN/AN/AN/A
NameEdm.Stringtruefalse true 152N/AN/AN/AN/A
NoteIDEdm.Int32falsefalse true N/AN/AN/AN/AN/A
SubjectEdm.Stringfalsetrue false 60N/AN/AN/AN/A

Note Navigational Properties

No navigational properties


OperationalUse Entity

Verb(s)Required Permission(s)LinkDescription

Key(s)
OperationalUseID

OperationalUse Structural Properties

PropertyTypeNullableMandatoryRead-OnlyString lengthMin ValueMax ValuePrecisionMax Dec PlacesIs Only DateDescription
DetailEdm.Stringfalsetrue false 50N/AN/AN/AN/A
OperationalUseIDEdm.Int32falsefalse false N/AN/AN/AN/AN/A

OperationalUse Navigational Properties

No navigational properties


OutputConnector Entity - Entity providing details of the outlet

Verb(s)Required Permission(s)LinkDescription

Key(s)
OutputConnectorID

OutputConnector Structural Properties

PropertyTypeNullableMandatoryRead-OnlyString lengthMin ValueMax ValuePrecisionMax Dec PlacesIs Only DateDescription
AssetIDEdm.Int32truefalse false N/AN/AN/AN/AN/AThe asset id of the power asset
BreakerIDEdm.Int32truefalse false N/AN/AN/AN/AN/APDU Breaker ID
DescriptionEdm.Stringtruefalse false 50N/AN/AN/AN/AOutlet Name. This must be unique for a power asset.
EnabledEdm.Booleanfalsefalse false N/AN/AN/AN/AN/A
LocationGroupIDEdm.Int32truefalse false N/AN/AN/AN/AN/AForeign key identifying the power asset location
MaxAEdm.Int32truefalse false N/AN/AN/AN/AN/A
OutputConnectorIDEdm.Int32falsefalse false N/AN/AN/AN/AN/A
OutputConnectorMaterialIDEdm.Int32truefalse false N/AN/AN/AN/AN/AForeign key identifying the material outlet

OutputConnector Navigational Properties

PropertyType
BreakerNlyte.Model.Breaker
GraphsCollection(Nlyte.Model.Graph)
LocationGroupNlyte.Model.LocationGroup
OutputConnectorMaterialNlyte.Model.OutputConnectorMaterial
OutputConnectorWiresCollection(Nlyte.Model.OutputConnectorWire)
PowerAssetNlyte.Model.Asset



OutputConnectorMaterial Entity - Entity representing the outlet material

Verb(s)Required Permission(s)LinkDescription

Key(s)
OutputConnectorMaterialID

OutputConnectorMaterial Structural Properties

PropertyTypeNullableMandatoryRead-OnlyString lengthMin ValueMax ValuePrecisionMax Dec PlacesIs Only DateDescription
DescriptionEdm.Stringtruefalse false 50N/AN/AN/AN/A
MaterialIDEdm.Int32truefalse true N/AN/AN/AN/AN/AThe parent material, holding the outlet
MaxAEdm.Int32truefalse false N/AN/AN/AN/AN/A
OutputConnectorMaterialIDEdm.Int32falsefalse false N/AN/AN/AN/AN/APrimary key
OutputConnectorTypeIDEdm.Int32truefalse false N/AN/AN/AN/AN/AThe ID of one of the predefined output connector types.
PositionEdm.Int32falsefalse false N/AN/AN/AN/AN/APlug position, read-only information
PowerTypeIDNlyte.Model.PowerTypeEnumtruefalse false N/AN/AN/AN/AN/APower type inherited from the parent material

OutputConnectorMaterial Navigational Properties

PropertyType
DistributorMaterialNlyte.Model.DistributorMaterial
OutputConnectorMaterialWiresCollection(Nlyte.Model.OutputConnectorMaterialWire)
OutputConnectorTypeNlyte.Model.OutputConnectorType



OutputConnectorMaterialWire Entity - The power supplier outlet wire material

Verb(s)Required Permission(s)LinkDescription

Key(s)
OutputConnectorMaterialWireID

OutputConnectorMaterialWire Structural Properties

PropertyTypeNullableMandatoryRead-OnlyString lengthMin ValueMax ValuePrecisionMax Dec PlacesIs Only DateDescription
OutputConnectorMaterialIDEdm.Int32truefalse false N/AN/AN/AN/AN/AThe outlet material
OutputConnectorMaterialWireIDEdm.Int32falsefalse false N/AN/AN/AN/AN/A
SlotPositionEdm.Int32falsefalse false N/AN/AN/AN/AN/A
WirePositionEdm.Int32falsefalse false N/AN/AN/AN/AN/A

OutputConnectorMaterialWire Navigational Properties

PropertyType
OutputConnectorMaterialNlyte.Model.OutputConnectorMaterial



OutputConnectorRealTimeData Entity

Verb(s)Required Permission(s)LinkDescription
GetWS-ReadOutputConnectorRealtimeDataintegration/api/odata/OutputConnectorRealTimeData, integration/api/odata/OutputConnectorRealTimeData({key})

Key(s)
OutputConnectorRealtimeDataID

OutputConnectorRealTimeData Structural Properties

PropertyTypeNullableMandatoryRead-OnlyString lengthMin ValueMax ValuePrecisionMax Dec PlacesIs Only DateDescription
AssetIDEdm.Int32falsefalse false N/AN/AN/AN/AN/A
ConnectorNoEdm.Int32falsefalse false N/AN/AN/AN/AN/A
LastUpdatedEdm.DateTimeOffsetfalsefalse false N/AN/AN/AN/AN/A
LocationGroupIDEdm.Int32falsefalse false N/AN/AN/AN/AN/A
OutputConnectorIDEdm.Int32falsefalse false N/AN/AN/AN/AN/A
OutputConnectorRealtimeDataIDEdm.Int32falsefalse false N/AN/AN/AN/AN/A
ProviderIDEdm.Int32falsefalse false N/AN/AN/AN/AN/A
RealtimeLoadEdm.Decimaltruefalse false N/AN/AN/AN/AN/A
RealtimeLoadAverageEdm.Decimaltruefalse false N/AN/AN/AN/AN/A
RealtimeLoadMaxEdm.Decimaltruefalse false N/AN/AN/AN/AN/A
RealtimeLoadMinEdm.Decimaltruefalse false N/AN/AN/AN/AN/A
RealtimePowerEdm.Decimaltruefalse false N/AN/AN/AN/AN/A
RealtimePowerAverageEdm.Decimaltruefalse false N/AN/AN/AN/AN/A
RealtimePowerMaxEdm.Decimaltruefalse false N/AN/AN/AN/AN/A
RealtimePowerMinEdm.Decimaltruefalse false N/AN/AN/AN/AN/A
RealtimeTotalEnergyEdm.Decimaltruefalse false N/AN/AN/AN/AN/A
RealtimeVoltageEdm.Decimaltruefalse false N/AN/AN/AN/AN/A
RealtimeVoltageAverageEdm.Decimaltruefalse false N/AN/AN/AN/AN/A
RealtimeVoltageMaxEdm.Decimaltruefalse false N/AN/AN/AN/AN/A
RealtimeVoltageMinEdm.Decimaltruefalse false N/AN/AN/AN/AN/A

OutputConnectorRealTimeData Navigational Properties

No navigational properties


OutputConnectorRealTimePhaseData Entity

Verb(s)Required Permission(s)LinkDescription
GetWS-ReadOutputConnectorRealtimePhaseDataintegration/api/odata/OutputConnectorRealTimePhaseData, integration/api/odata/OutputConnectorRealTimePhaseData({key})

Key(s)
OutputConnectorRealtimePhaseDataID

OutputConnectorRealTimePhaseData Structural Properties

PropertyTypeNullableMandatoryRead-OnlyString lengthMin ValueMax ValuePrecisionMax Dec PlacesIs Only DateDescription
AssetIDEdm.Int32falsefalse false N/AN/AN/AN/AN/A
ConnectorNoEdm.Int32falsefalse false N/AN/AN/AN/AN/A
LastUpdatedEdm.DateTimeOffsetfalsefalse false N/AN/AN/AN/AN/A
LocationGroupIDEdm.Int32falsefalse false N/AN/AN/AN/AN/A
OutputConnectorIDEdm.Int32falsefalse false N/AN/AN/AN/AN/A
OutputConnectorRealtimePhaseDataIDEdm.Int32falsefalse false N/AN/AN/AN/AN/A
Phase1RealtimeLoadEdm.Decimaltruefalse false N/AN/AN/AN/AN/A
Phase1RealtimeLoadAverageEdm.Decimaltruefalse false N/AN/AN/AN/AN/A
Phase1RealtimeLoadMaxEdm.Decimaltruefalse false N/AN/AN/AN/AN/A
Phase1RealtimeLoadMinEdm.Decimaltruefalse false N/AN/AN/AN/AN/A
Phase1RealtimePowerEdm.Decimaltruefalse false N/AN/AN/AN/AN/A
Phase1RealtimePowerAverageEdm.Decimaltruefalse false N/AN/AN/AN/AN/A
Phase1RealtimePowerMaxEdm.Decimaltruefalse false N/AN/AN/AN/AN/A
Phase1RealtimePowerMinEdm.Decimaltruefalse false N/AN/AN/AN/AN/A
Phase1RealtimeVoltageEdm.Decimaltruefalse false N/AN/AN/AN/AN/A
Phase1RealtimeVoltageAverageEdm.Decimaltruefalse false N/AN/AN/AN/AN/A
Phase1RealtimeVoltageMaxEdm.Decimaltruefalse false N/AN/AN/AN/AN/A
Phase1RealtimeVoltageMinEdm.Decimaltruefalse false N/AN/AN/AN/AN/A
Phase2RealtimeLoadEdm.Decimaltruefalse false N/AN/AN/AN/AN/A
Phase2RealtimeLoadAverageEdm.Decimaltruefalse false N/AN/AN/AN/AN/A
Phase2RealtimeLoadMaxEdm.Decimaltruefalse false N/AN/AN/AN/AN/A
Phase2RealtimeLoadMinEdm.Decimaltruefalse false N/AN/AN/AN/AN/A
Phase2RealtimePowerEdm.Decimaltruefalse false N/AN/AN/AN/AN/A
Phase2RealtimePowerAverageEdm.Decimaltruefalse false N/AN/AN/AN/AN/A
Phase2RealtimePowerMaxEdm.Decimaltruefalse false N/AN/AN/AN/AN/A
Phase2RealtimePowerMinEdm.Decimaltruefalse false N/AN/AN/AN/AN/A
Phase2RealtimeVoltageEdm.Decimaltruefalse false N/AN/AN/AN/AN/A
Phase2RealtimeVoltageAverageEdm.Decimaltruefalse false N/AN/AN/AN/AN/A
Phase2RealtimeVoltageMaxEdm.Decimaltruefalse false N/AN/AN/AN/AN/A
Phase2RealtimeVoltageMinEdm.Decimaltruefalse false N/AN/AN/AN/AN/A
Phase3RealtimeLoadEdm.Decimaltruefalse false N/AN/AN/AN/AN/A
Phase3RealtimeLoadAverageEdm.Decimaltruefalse false N/AN/AN/AN/AN/A
Phase3RealtimeLoadMaxEdm.Decimaltruefalse false N/AN/AN/AN/AN/A
Phase3RealtimeLoadMinEdm.Decimaltruefalse false N/AN/AN/AN/AN/A
Phase3RealtimePowerEdm.Decimaltruefalse false N/AN/AN/AN/AN/A
Phase3RealtimePowerAverageEdm.Decimaltruefalse false N/AN/AN/AN/AN/A
Phase3RealtimePowerMaxEdm.Decimaltruefalse false N/AN/AN/AN/AN/A
Phase3RealtimePowerMinEdm.Decimaltruefalse false N/AN/AN/AN/AN/A
Phase3RealtimeVoltageEdm.Decimaltruefalse false N/AN/AN/AN/AN/A
Phase3RealtimeVoltageAverageEdm.Decimaltruefalse false N/AN/AN/AN/AN/A
Phase3RealtimeVoltageMaxEdm.Decimaltruefalse false N/AN/AN/AN/AN/A
Phase3RealtimeVoltageMinEdm.Decimaltruefalse false N/AN/AN/AN/AN/A
ProviderIDEdm.Int32falsefalse false N/AN/AN/AN/AN/A

OutputConnectorRealTimePhaseData Navigational Properties

No navigational properties


OutputConnectorType Entity

Verb(s)Required Permission(s)LinkDescription

Key(s)
OutputConnectorTypeID

OutputConnectorType Structural Properties

PropertyTypeNullableMandatoryRead-OnlyString lengthMin ValueMax ValuePrecisionMax Dec PlacesIs Only DateDescription
NameEdm.Stringfalsetrue false 50N/AN/AN/AN/A
OutputConnectorTypeIDEdm.Int32falsefalse false N/AN/AN/AN/AN/A

OutputConnectorType Navigational Properties

No navigational properties


OutputConnectorWire Entity

Verb(s)Required Permission(s)LinkDescription

Key(s)
OutputConnectorWireID

OutputConnectorWire Structural Properties

PropertyTypeNullableMandatoryRead-OnlyString lengthMin ValueMax ValuePrecisionMax Dec PlacesIs Only DateDescription
OutputConnectorIDEdm.Int32truefalse false N/AN/AN/AN/AN/A
OutputConnectorWireIDEdm.Int32falsefalse false N/AN/AN/AN/AN/A
SlotPositionEdm.Int32truefalse false N/AN/AN/AN/AN/A
WireIDEdm.Int32truefalse false N/AN/AN/AN/AN/A

OutputConnectorWire Navigational Properties

PropertyType
OutputConnectorNlyte.Model.OutputConnector
WireNlyte.Model.Wire



Overlay Entity

Verb(s)Required Permission(s)LinkDescription

Key(s)
RoomItemID

Overlay Structural Properties

PropertyTypeNullableMandatoryRead-OnlyString lengthMin ValueMax ValuePrecisionMax Dec PlacesIs Only DateDescription
ColourEdm.Stringtruefalse false N/AN/AN/AN/AN/A
ResultEdm.Stringtruefalse false N/AN/AN/AN/AN/A
RoomItemIDEdm.Int32falsefalse false N/AN/AN/AN/AN/A
ValueEdm.Stringtruefalse false N/AN/AN/AN/AN/A

Overlay Navigational Properties

No navigational properties


PagedAutoAllocateSearchResult Entity

Verb(s)Required Permission(s)LinkDescription

Key(s)
SearchClientId

PagedAutoAllocateSearchResult Structural Properties

PropertyTypeNullableMandatoryRead-OnlyString lengthMin ValueMax ValuePrecisionMax Dec PlacesIs Only DateDescription
CurrentPageCollection(Nlyte.Model.AutoAllocateSearchResult)truefalse false N/AN/AN/AN/AN/A
RangeEndEdm.Int32falsefalse false N/AN/AN/AN/AN/A
RangeStartEdm.Int32falsefalse false N/AN/AN/AN/AN/A
SearchClientIdEdm.Stringfalsefalse false N/AN/AN/AN/AN/A
TotalCountEdm.Int32falsefalse false N/AN/AN/AN/AN/A

PagedAutoAllocateSearchResult Navigational Properties

No navigational properties


PanelNetworkMaterial Entity : NetworkMaterial

Verb(s)Required Permission(s)LinkDescription
GetWS-ReadNetworkMaterialintegration/api/odata/PanelNetworkMaterials, integration/api/odata/PanelNetworkMaterials({key})
PostWS-AddNetworkMaterialintegration/api/odata/PanelNetworkMaterials
PostWithKeyWS-ModifyNetworkMaterial
PatchWS-ModifyNetworkMaterialintegration/api/odata/PanelNetworkMaterials({key})
DeleteWS-ModifyNetworkMaterialintegration/api/odata/PanelNetworkMaterials({key})

Key(s)
MaterialID

PanelNetworkMaterial Structural Properties

PropertyTypeNullableMandatoryRead-OnlyString lengthMin ValueMax ValuePrecisionMax Dec PlacesIs Only DateDescription
MaterialCategoryIDEdm.Int32truefalse false N/AN/AN/AN/AN/A
NetworkPanelTypeIDNlyte.Model.NetworkPanelTypeEnumtruefalse false N/AN/AN/AN/AN/A
WorkableFootPrintFrontEdm.Doublefalsefalse false N/A0999999999999.9999164
WorkableFootPrintHeightEdm.Doublefalsefalse false N/A0999999999999.9999164
WorkableFootPrintRearEdm.Doublefalsefalse false N/A0999999999999.9999164

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)LinkDescription
GetWS-ReadPDUintegration/api/odata/PDUs, integration/api/odata/PDUs({key})
DeleteWS-ModifyPDUintegration/api/odata/PDUs({key})
PatchWS-ModifyPDUintegration/api/odata/PDUs({key})
PostWithKeyWS-ModifyPDUintegration/api/odata/PDUs({key})
PostWS-AddPDUintegration/api/odata/PDUs

Key(s)
AssetID

PDU Structural Properties

PropertyTypeNullableMandatoryRead-OnlyString lengthMin ValueMax ValuePrecisionMax Dec PlacesIs Only DateDescription
AuditDateEdm.DateTimeOffsettruefalse false N/AN/AN/AN/AN/A
AuditStatusCorrectEdm.Booleantruefalse false N/AN/AN/AN/AN/A
CurrentPowerFactorEdm.Decimaltruefalse true N/AN/AN/AN/AN/ARead-only property representing the percentage of power drawn by a PDD asset that is available to its consumers
DirectCurrentVoltageEdm.Doublefalsefalse false N/AN/AN/AN/AN/A
IsMasterRedundancyDeviceEdm.Booleanfalsefalse false N/AN/AN/AN/AN/AValue inserted by the user
LastAuditorAccountIDEdm.Int32truefalse false N/AN/AN/AN/AN/A
ManufactureDateEdm.DateTimeOffsettruefalse false N/AN/AN/AN/AN/AIsOnlyDate
OnePhaseVoltageEdm.Doublefalsefalse false N/AN/AN/AN/AN/A
OutputCountEdm.Int32falsefalse true N/AN/AN/AN/AN/A
PowerFactorEdm.Decimaltruefalse false N/A099.9942
PowerFactorOverrideEdm.Decimaltruefalse false N/AN/AN/AN/AN/AValue provided by the user, overriding the CurrentPowerFactor value
RatedKVAEdm.Int32truefalse false N/AN/AN/AN/AN/A
RealtimePowerFactorEdm.Decimaltruefalse true N/AN/AN/AN/AN/ARead-only value.
ServiceDateEdm.DateTimeOffsettruefalse false N/AN/AN/AN/AN/AIsOnlyDate
ThreePhaseVoltageEdm.Doublefalsefalse false N/AN/AN/AN/AN/A
TwoPhaseVoltageEdm.Doublefalsefalse false N/AN/AN/AN/AN/A
UpsNameEdm.Stringtruefalse false 30N/AN/AN/AN/A
UseAlternatingPositionsEdm.Booleanfalsetrue false N/AN/AN/AN/AN/A

PDU Navigational Properties

PropertyType
BreakerPanelsCollection(Nlyte.Model.BreakerPanel)
OutputConnectorsCollection(Nlyte.Model.OutputConnector)
PDUMaterialNlyte.Model.PDUMaterial
UtilitiesCollection(Nlyte.Model.Supplier)
WiresCollection(Nlyte.Model.Wire)



PDUMaterial Entity : Material - Material type inheriting properties from the base type

Verb(s)Required Permission(s)LinkDescription
GetWS-ReadPDUMaterialintegration/api/odata/PDUMaterials, integration/api/odata/PDUMaterials({key})
PostWS-AddPDUMaterialintegration/api/odata/PDUMaterials
PostWithKeyWS-ModifyPDUMaterial
PatchWS-ModifyPDUMaterialintegration/api/odata/PDUMaterials({key})
DeleteWS-ModifyPDUMaterialintegration/api/odata/PDUMaterials({key})

Key(s)
MaterialID

PDUMaterial Structural Properties

PropertyTypeNullableMandatoryRead-OnlyString lengthMin ValueMax ValuePrecisionMax Dec PlacesIs Only DateDescription
CalculatedMaxKWEdm.Decimaltruefalse true N/AN/AN/AN/AN/A
DirectCurrentVoltageEdm.Doublefalsefalse false N/A0999999999999999150
DistributorPowerFactorEdm.Decimalfalsefalse true N/AN/AN/AN/AN/A
MaterialCategoryIDEdm.Int32truefalse false N/AN/AN/AN/AN/A
MaterialSubtypeIDEdm.Int32truefalse true N/AN/AN/AN/AN/A
MaxAEdm.Decimaltruefalse false N/A099999.99983
MaxVEdm.Decimaltruefalse false N/A099999.99983
OnePhaseVoltageEdm.Doublefalsetrue false N/A1999999999999999150
ThreePhaseVoltageEdm.Doublefalsetrue false N/A1999999999999999150
TwoPhaseVoltageEdm.Doublefalsetrue false N/A1999999999999999150
UHeightEdm.Int64falsefalse true N/AN/AN/AN/AN/A
WorkableFootPrintFrontEdm.Doublefalsefalse false N/A0999999999999.9999164
WorkableFootPrintHeightEdm.Doublefalsefalse false N/A0999999999999.9999164
WorkableFootPrintRearEdm.Doublefalsefalse false N/A0999999999999.9999164

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)LinkDescription
GetWS-ReadPeripheralintegration/api/odata/Peripherals, integration/api/odata/Peripherals({key})
PatchWS-ModifyPeripheralintegration/api/odata/Peripherals({key})
PostWithKeyWS-ModifyPeripheralintegration/api/odata/Peripherals({key})
DeleteWS-ModifyPeripheralintegration/api/odata/Peripherals({key})
PostWS-AddPeripheralintegration/api/odata/Peripherals

Key(s)
AssetID

Peripheral Structural Properties

PropertyTypeNullableMandatoryRead-OnlyString lengthMin ValueMax ValuePrecisionMax Dec PlacesIs Only DateDescription
AuditDateEdm.DateTimeOffsettruefalse false N/AN/AN/AN/AN/A
AuditStatusCorrectEdm.Booleantruefalse false N/AN/AN/AN/AN/A
DiskCapacityEdm.Doubletruefalse false N/AN/AN/AN/AN/A
LastAuditorAccountIDEdm.Int32truefalse false N/AN/AN/AN/AN/A
OwnerAssetIDEdm.Int32truefalse false N/AN/AN/AN/AN/A
StorageUsageIDEdm.Int32truefalse false N/AN/AN/AN/AN/A
TotalMemoryEdm.Doubletruefalse false N/AN/AN/AN/AN/A
TotalPlugsEdm.Int32falsefalse true N/AN/AN/AN/AN/A

Peripheral Navigational Properties

PropertyType
ConnectedAssetsCollection(Nlyte.Model.PeripheralAssetLink)
InputConnectorsCollection(Nlyte.Model.InputConnector)
OwnerAssetNlyte.Model.Asset
PeripheralMaterialNlyte.Model.PeripheralMaterial
StorageUsageNlyte.Model.StorageUsage



PeripheralAssetLink Entity

Verb(s)Required Permission(s)LinkDescription
GetWS-ReadPeripheralAssetLink
PatchWS-ModifyPeripheralAssetLink
DeleteWS-ModifyPeripheralAssetLink
PostWS-AddPeripheralAssetLink

Key(s)
PeripheralAssetLinkID

PeripheralAssetLink Structural Properties

PropertyTypeNullableMandatoryRead-OnlyString lengthMin ValueMax ValuePrecisionMax Dec PlacesIs Only DateDescription
ConnectedAssetIDEdm.Int32truefalse false N/AN/AN/AN/AN/A
ConnectedAssetSlotEdm.Stringtruefalse false 100N/AN/AN/AN/A
PeripheralAssetIDEdm.Int32falsefalse false N/AN/AN/AN/AN/A
PeripheralAssetLinkIDEdm.Int32falsefalse false N/AN/AN/AN/AN/A

PeripheralAssetLink Navigational Properties

PropertyType
ConnectedAssetNlyte.Model.Asset
NotesCollection(Nlyte.Model.PeripheralAssetLinkNote)
PeripheralAssetNlyte.Model.Peripheral



PeripheralAssetLinkNote Entity : Note

Verb(s)Required Permission(s)LinkDescription
PostWS-AddNote
PatchWS-ModifyNote
DeleteWS-ModifyNote
GetWS-ReadNote

Key(s)
NoteID

PeripheralAssetLinkNote Structural Properties

No structural properties

PeripheralAssetLinkNote Navigational Properties

No navigational properties


PeripheralMaterial Entity : Material - Material type inheriting properties from the base type

Verb(s)Required Permission(s)LinkDescription
GetWS-ReadPeripheralMaterialintegration/api/odata/PeripheralMaterials, integration/api/odata/PeripheralMaterials({key})
PostWS-AddPeripheralMaterialintegration/api/odata/PeripheralMaterials
PostWithKeyWS-ModifyPeripheralMaterial
PatchWS-ModifyPeripheralMaterialintegration/api/odata/PeripheralMaterials({key})
DeleteWS-ModifyPeripheralMaterialintegration/api/odata/PeripheralMaterials({key})

Key(s)
MaterialID

PeripheralMaterial Structural Properties

PropertyTypeNullableMandatoryRead-OnlyString lengthMin ValueMax ValuePrecisionMax Dec PlacesIs Only DateDescription
MaterialCategoryIDEdm.Int32truefalse false N/AN/AN/AN/AN/A
MountingTypeIDNlyte.Model.MountingTypeEnumtruefalse false N/AN/AN/AN/AN/A
UHeightEdm.Int64falsefalse true N/AN/AN/AN/AN/A

PeripheralMaterial Navigational Properties

No navigational properties


Permission Entity

Verb(s)Required Permission(s)LinkDescription

Key(s)
PermissionID

Permission Structural Properties

PropertyTypeNullableMandatoryRead-OnlyString lengthMin ValueMax ValuePrecisionMax Dec PlacesIs Only DateDescription
DescriptionEdm.Stringtruefalse false 255N/AN/AN/AN/A
DetailEdm.Stringfalsetrue false 50N/AN/AN/AN/APermission
PermissionIDEdm.Int32falsefalse false N/AN/AN/AN/AN/A

Permission Navigational Properties

No navigational properties


PhysicalPartition Entity

Verb(s)Required Permission(s)LinkDescription
GetWS-ReadPhysicalPartition
PatchWS-ModifyPhysicalPartition
DeleteWS-ModifyPhysicalPartition
PostWS-AddPhysicalPartition

Key(s)
PhysicalPartitionID

PhysicalPartition Structural Properties

PropertyTypeNullableMandatoryRead-OnlyString lengthMin ValueMax ValuePrecisionMax Dec PlacesIs Only DateDescription
PhysicalPartitionIDEdm.Int32falsefalse false N/AN/AN/AN/AN/A
PhysicalPartitionNameEdm.Stringfalsetrue false 30N/AN/AN/AN/A
PhysicalPartitionTypeIDEdm.Int32truetrue false N/AN/AN/AN/AN/A
ServerAssetIDEdm.Int32truefalse false N/AN/AN/AN/AN/A

PhysicalPartition Navigational Properties

PropertyType
AssetNlyte.Model.Asset
PhysicalPartitionTypeNlyte.Model.PhysicalPartitionType



PhysicalPartitionType Entity

Verb(s)Required Permission(s)LinkDescription

Key(s)
PhysicalPartitionTypeID

PhysicalPartitionType Structural Properties

PropertyTypeNullableMandatoryRead-OnlyString lengthMin ValueMax ValuePrecisionMax Dec PlacesIs Only DateDescription
DetailEdm.Stringfalsetrue false 30N/AN/AN/AN/A
PhysicalPartitionTypeIDEdm.Int32falsefalse false N/AN/AN/AN/AN/A

PhysicalPartitionType Navigational Properties

No navigational properties


PollType Entity - Entity used for the list of Poll Types used for NEO

Verb(s)Required Permission(s)LinkDescription

Key(s)
Id

PollType Structural Properties

PropertyTypeNullableMandatoryRead-OnlyString lengthMin ValueMax ValuePrecisionMax Dec PlacesIs Only DateDescription
IdEdm.Int32falsefalse false N/AN/AN/AN/AN/A
NameEdm.Stringtruefalse false N/AN/AN/AN/AN/A

PollType Navigational Properties

No navigational properties


Polygon Entity

Verb(s)Required Permission(s)LinkDescription
GetWS-ReadRoomPlan
PatchWS-ModifyRoomPlan
PutWS-ModifyRoomPlan
DeleteWS-ModifyRoomPlan
PostWS-ModifyRoomPlan

Key(s)
ID

Polygon Structural Properties

PropertyTypeNullableMandatoryRead-OnlyString lengthMin ValueMax ValuePrecisionMax Dec PlacesIs Only DateDescription
BoundaryLengthEdm.Decimaltruefalse false N/AN/AN/AN/AN/A
DisplayPropertiesIDEdm.Int32truefalse true N/AN/AN/AN/AN/A
FillTypeNlyte.Model.FillTypefalsefalse false N/AN/AN/AN/AN/A
IDEdm.Int32falsefalse false N/AN/AN/AN/AN/A
IsClosedEdm.Booleanfalsefalse false N/AN/AN/AN/AN/A
LineWidthEdm.Decimaltruefalse false N/AN/AN/AN/AN/A
SaveActionNlyte.Model.SaveActionEnumfalsefalse false N/AN/AN/AN/AN/A
TopLeftOffsetAnchorIDEdm.Int32truefalse true N/AN/AN/AN/AN/A
TotalAreaEdm.Decimalfalsefalse true N/AN/AN/AN/AN/A

Polygon Navigational Properties

PropertyType
AnchorNlyte.Model.Anchor
DisplayPropertiesNlyte.Model.DisplayProperties
PolygonPointsCollection(Nlyte.Model.PolygonPoint)



PolygonPoint Entity

Verb(s)Required Permission(s)LinkDescription
GetWS-ReadRoomPlan
PatchWS-ModifyRoomPlan
PutWS-ModifyRoomPlan
DeleteWS-ModifyRoomPlan
PostWS-ModifyRoomPlan

Key(s)
ID

PolygonPoint Structural Properties

PropertyTypeNullableMandatoryRead-OnlyString lengthMin ValueMax ValuePrecisionMax Dec PlacesIs Only DateDescription
IDEdm.Int32falsefalse false N/AN/AN/AN/AN/A
OrderIndexEdm.Int32falsefalse false N/AN/AN/AN/AN/A
PolygonIDEdm.Int32truefalse true N/AN/AN/AN/AN/A
SaveActionNlyte.Model.SaveActionEnumfalsefalse false N/AN/AN/AN/AN/A
XEdm.Decimalfalsefalse false N/A09999999.999103
YEdm.Decimalfalsefalse false N/A09999999.999103

PolygonPoint Navigational Properties

PropertyType
PolygonNlyte.Model.Polygon



PowerMaterial Entity - Power material providing details on the power type of the material

Verb(s)Required Permission(s)LinkDescription

Key(s)
MaterialID

PowerMaterial Structural Properties

PropertyTypeNullableMandatoryRead-OnlyString lengthMin ValueMax ValuePrecisionMax Dec PlacesIs Only DateDescription
HasStaticSwitchEdm.Booleanfalsefalse false N/AN/AN/AN/AN/A
InputCountEdm.Int32falsefalse false N/AN/AN/AN/AN/A
InputPowerTypeIDNlyte.Model.PowerTypeEnumtruefalse false N/AN/AN/AN/AN/APower type: phased or direct current
MaterialIDEdm.Int32falsefalse false N/AN/AN/AN/AN/A
RequiredInputsEdm.Int32falsefalse false N/AN/AN/AN/AN/A

PowerMaterial Navigational Properties

PropertyType
ConsumerMaterialNlyte.Model.ConsumerMaterial
DistributorMaterialNlyte.Model.DistributorMaterial
InputConnectorMaterialsCollection(Nlyte.Model.InputConnectorMaterial)
MaterialNlyte.Model.Material



PowerStrip Entity : Asset - Asset created from a material of type power strip, entity inheriting the Nlyte.Model.Asset entity

Verb(s)Required Permission(s)LinkDescription
GetWS-ReadPowerStripintegration/api/odata/PowerStrips, integration/api/odata/PowerStrips({key})
DeleteWS-ModifyPowerStripintegration/api/odata/PowerStrips({key})
PatchWS-ModifyPowerStripintegration/api/odata/PowerStrips({key})
PostWithKeyWS-ModifyPowerStripintegration/api/odata/PowerStrips({key})
PostWS-AddPowerStripintegration/api/odata/PowerStrips

Key(s)
AssetID

PowerStrip Structural Properties

PropertyTypeNullableMandatoryRead-OnlyString lengthMin ValueMax ValuePrecisionMax Dec PlacesIs Only DateDescription
AuditDateEdm.DateTimeOffsettruefalse false N/AN/AN/AN/AN/A
AuditStatusCorrectEdm.Booleantruefalse false N/AN/AN/AN/AN/A
CurrentPowerFactorEdm.Decimaltruefalse true N/AN/AN/AN/AN/ARead-only property representing the percentage of power drawn by a PDD asset that is available to its consumers
FreeOutletsEdm.Int32falsefalse true N/AN/AN/AN/AN/ARead-only value, describing available outlets that can be used to create network connections
IsMasterRedundancyDeviceEdm.Booleanfalsefalse false N/AN/AN/AN/AN/AValue inserted by the user
LastAuditorAccountIDEdm.Int32truefalse false N/AN/AN/AN/AN/A
OutputCountEdm.Int32falsefalse true N/AN/AN/AN/AN/A
PowerFactorOverrideEdm.Decimaltruefalse false N/A0132Value provided by the user, overriding the CurrentPowerFactor value
RealtimePowerFactorEdm.Decimaltruefalse true N/AN/AN/AN/AN/ARead-only value.
TotalPlugsEdm.Int32falsefalse true N/AN/AN/AN/AN/A

PowerStrip Navigational Properties

PropertyType
InputConnectorsCollection(Nlyte.Model.InputConnector)
OutputConnectorsCollection(Nlyte.Model.OutputConnector)
PowerStripMaterialNlyte.Model.PowerStripMaterial
UtilitiesCollection(Nlyte.Model.Supplier)
WiresCollection(Nlyte.Model.Wire)



PowerStripMaterial Entity : Material - Material type inheriting properties from the base type

Verb(s)Required Permission(s)LinkDescription
GetWS-ReadPowerStripMaterialintegration/api/odata/PowerStripMaterials, integration/api/odata/PowerStripMaterials({key})
PostWS-AddPowerStripMaterialintegration/api/odata/PowerStripMaterials
PostWithKeyWS-ModifyPowerStripMaterialintegration/api/odata/PowerStripMaterials({key})
PatchWS-ModifyPowerStripMaterialintegration/api/odata/PowerStripMaterials({key})
DeleteWS-ModifyPowerStripMaterialintegration/api/odata/PowerStripMaterials({key})

Key(s)
MaterialID

PowerStripMaterial Structural Properties

PropertyTypeNullableMandatoryRead-OnlyString lengthMin ValueMax ValuePrecisionMax Dec PlacesIs Only DateDescription
CalculatedMaxKWEdm.Decimaltruefalse true N/AN/AN/AN/AN/A
CordLengthEdm.Doubletruefalse false N/A09999950
DistributorPowerFactorEdm.Decimalfalsefalse true N/AN/AN/AN/AN/A
InputPowerTypeIDNlyte.Model.PowerTypeEnumfalsetrue false N/AN/AN/AN/AN/APower type: phased or direct current
MasterSwitchEdm.Booleanfalsefalse false N/AN/AN/AN/AN/A
MaterialCategoryIDEdm.Int32truefalse false N/AN/AN/AN/AN/A
MaxAmperageEdm.Decimaltruefalse false N/A099999.99983
MaxVoltageEdm.Decimaltruefalse false N/A099999.99983
OutletTypeEdm.Stringtruefalse false 50N/AN/AN/AN/A
PilotLightEdm.Booleanfalsefalse false N/AN/AN/AN/AN/A
PlugTypeEdm.Stringtruefalse false 50N/AN/AN/AN/AProperty selected from the available types, available as lookups InputConnectorTypes
RequiredPlugsEdm.Int32falsetrue false N/AN/AN/AN/AN/AValue inserted by the user, while the material is in Planned status
TotalOutletsEdm.Int32falsefalse false N/AN/AN/AN/AN/A
TotalPlugsEdm.Int32falsetrue false N/AN/AN/AN/AN/AValue inserted by the user, while the material is in Planned status
UHeightEdm.Int64falsefalse true N/AN/AN/AN/AN/A
WorkableFootPrintFrontEdm.Doublefalsefalse false N/A0999999999999.9999164
WorkableFootPrintHeightEdm.Doublefalsefalse false N/A0999999999999.9999164
WorkableFootPrintRearEdm.Doublefalsefalse false N/A0999999999999.9999164

PowerStripMaterial Navigational Properties

PropertyType
InputConnectorMaterialsCollection(Nlyte.Model.InputConnectorMaterial)
OutputConnectorMaterialsCollection(Nlyte.Model.OutputConnectorMaterial)



Process Entity

Verb(s)Required Permission(s)LinkDescription
GetWS-ReadProcessintegration/api/odata/Processes, integration/api/odata/Processes({key})
PostWS-AddProcessintegration/api/odata/Processes
PatchWS-ModifyProcessintegration/api/odata/Processes({key})
PutWS-ModifyProcessintegration/api/odata/Processes({key})

Key(s)
ID

Process Structural Properties

PropertyTypeNullableMandatoryRead-OnlyString lengthMin ValueMax ValuePrecisionMax Dec PlacesIs Only DateDescription
AllLocationsAreValidEdm.Booleanfalsefalse true N/AN/AN/AN/AN/A
CategoryNlyte.Model.ProcessCategoryfalsetrue false N/AN/AN/AN/AN/A
DateCreatedEdm.DateTimeOffsetfalsefalse true N/AN/AN/AN/AN/A
DateLastUpdatedEdm.DateTimeOffsetfalsefalse true N/AN/AN/AN/AN/A
DescriptionEdm.Stringtruefalse false 1000N/AN/AN/AN/A
DesignedByResourceIDEdm.Int32truefalse true N/AN/AN/AN/AN/A
IDEdm.Int32falsefalse true N/AN/AN/AN/AN/A
IsLatestVersionEdm.Booleanfalsefalse true N/AN/AN/AN/AN/A
LastUpdatedByResourceIDEdm.Int32truefalse true N/AN/AN/AN/AN/A
NameEdm.Stringfalsetrue false 250N/AN/AN/AN/AProcess Name. This must be unique.
PreventNameEditingAfterStartEdm.Booleanfalsefalse false N/AN/AN/AN/AN/A
StatusNlyte.Model.ProcessStatusfalsetrue true N/AN/AN/AN/AN/A
TotalDurationInMinutesEdm.Int64truefalse true N/AN/AN/AN/AN/A
TypeNlyte.Model.ProcessTypefalsetrue false N/AN/AN/AN/AN/A
UntrustedLocationGroupIdEdm.Int32truefalse false N/AN/AN/AN/AN/A
VersionEdm.Int32falsefalse true N/AN/AN/AN/AN/A

Process Navigational Properties

PropertyType
AssigneesCollection(Nlyte.Model.Assignee)
DesignedByResourceNlyte.Model.Resource
LastUpdatedByResourceNlyte.Model.Resource
LocationsCollection(Nlyte.Model.LocationGroup)
ProcessFormControlsCollection(Nlyte.Model.ProcessFormControl)
ProcessFormsCollection(Nlyte.Model.ProcessForm)
TaskContainersCollection(Nlyte.Model.TaskContainer)
TasksCollection(Nlyte.Model.Task)
UntrustedLocationGroupNlyte.Model.LocationGroup



ProcessForm Entity

Verb(s)Required Permission(s)LinkDescription

Key(s)
id

ProcessForm Structural Properties

PropertyTypeNullableMandatoryRead-OnlyString lengthMin ValueMax ValuePrecisionMax Dec PlacesIs Only DateDescription
DisplayNameEdm.Stringfalsetrue false N/AN/AN/AN/AN/A
FormIDEdm.Int32truefalse false N/AN/AN/AN/AN/A
FormOrderEdm.Int32falsefalse true N/AN/AN/AN/AN/A
idEdm.Int32falsefalse true N/AN/AN/AN/AN/A
ProcessIDEdm.Int32truefalse true N/AN/AN/AN/AN/A

ProcessForm Navigational Properties

PropertyType
FormNlyte.Model.Form
ProcessNlyte.Model.Process



ProcessFormControl Entity

Verb(s)Required Permission(s)LinkDescription

Key(s)
ID

ProcessFormControl Structural Properties

PropertyTypeNullableMandatoryRead-OnlyString lengthMin ValueMax ValuePrecisionMax Dec PlacesIs Only DateDescription
FormControlIDEdm.Int32truefalse false N/AN/AN/AN/AN/A
IDEdm.Int32falsefalse true N/AN/AN/AN/AN/A
IsEditableEdm.Booleanfalsefalse false N/AN/AN/AN/AN/A
IsVisibleEdm.Booleanfalsefalse false N/AN/AN/AN/AN/A
ProcessIDEdm.Int32truefalse true N/AN/AN/AN/AN/A

ProcessFormControl Navigational Properties

PropertyType
FormControlNlyte.Model.FormControl
ProcessNlyte.Model.Process



Project Entity

Verb(s)Required Permission(s)LinkDescription

Key(s)
ProjectID

Project Structural Properties

PropertyTypeNullableMandatoryRead-OnlyString lengthMin ValueMax ValuePrecisionMax Dec PlacesIs Only DateDescription
ActualEndDateEdm.DateTimeOffsettruefalse true N/AN/AN/AN/AN/AIsOnlyDate
ActualStartDateEdm.DateTimeOffsettruefalse true N/AN/AN/AN/AN/AIsOnlyDate
AutoAllocationEndDateEdm.DateTimeOffsettruefalse true N/AN/AN/AN/AN/A
AutoAllocationStartDateEdm.DateTimeOffsettruefalse true N/AN/AN/AN/AN/A
BusinessGroupIDEdm.Int32truefalse false N/AN/AN/AN/AN/A
CreationDateEdm.DateTimeOffsettruefalse true N/AN/AN/AN/AN/A
DefaultCabinetUsageIDEdm.Int32truefalse false N/AN/AN/AN/AN/A
ExpectedEndDateEdm.DateTimeOffsetfalsefalse false N/AN/AN/AN/AN/AIsOnlyDate
ExpectedStartDateEdm.DateTimeOffsetfalsefalse false N/AN/AN/AN/AN/AIsOnlyDate
ProjectIDEdm.Int32falsefalse true N/AN/AN/AN/AN/A
ProjectNameEdm.Stringfalsetrue false 40N/AN/AN/AN/A
ProjectNumberEdm.Int32truefalse true N/AN/AN/AN/AN/A
ProjectStatusNlyte.Model.ProjectStatusEnumtrue false
ProjectTypeNlyte.Model.ProjectTypeEnumfalse false

Project Navigational Properties

PropertyType
BusinessGroupNlyte.Model.BusinessGroup
CabinetUsageNlyte.Model.CabinetUsage
ProjectDependenciesCollection(Nlyte.Model.ProjectDependency)
ProjectDependentsCollection(Nlyte.Model.ProjectDependency)
ProjectItemAllocateCriteriasCollection(Nlyte.Model.ProjectItemAllocateCriteria)
ProjectItemsCollection(Nlyte.Model.ProjectItem)



ProjectAction Entity

Verb(s)Required Permission(s)LinkDescription

Key(s)
ProjectActionID

ProjectAction Structural Properties

PropertyTypeNullableMandatoryRead-OnlyString lengthMin ValueMax ValuePrecisionMax Dec PlacesIs Only DateDescription
DetailEdm.Stringfalsetrue false 30N/AN/AN/AN/AProject action
ProjectActionIDEdm.Int32falsefalse false N/AN/AN/AN/AN/A

ProjectAction Navigational Properties

No navigational properties


ProjectDependency Entity

Verb(s)Required Permission(s)LinkDescription

Key(s)
ProjectDependenciesID

ProjectDependency Structural Properties

PropertyTypeNullableMandatoryRead-OnlyString lengthMin ValueMax ValuePrecisionMax Dec PlacesIs Only DateDescription
OrderEdm.Int32falsefalse false N/AN/AN/AN/AN/A
ProjectChildIDEdm.Int32truefalse true N/AN/AN/AN/AN/A
ProjectDependenciesIDEdm.Int32falsefalse true N/AN/AN/AN/AN/A
ProjectParentIDEdm.Int32truefalse true N/AN/AN/AN/AN/A

ProjectDependency Navigational Properties

PropertyType
ProjectChildNlyte.Model.Project
ProjectParentNlyte.Model.Project



ProjectItem Entity - Entity representing a material or an asset, member of a project

Verb(s)Required Permission(s)LinkDescription
GetWS-ReadChassis,WS-ReadServer,WS-ReadNetwork,WS-ReadPeripheral,WS-ReadServerHost,WS-ReadNetworkMaterial,WS-ReadChassisMaterial,WS-ReadPeripheralMaterial,WS-ReadServerMaterialintegration/api/odata/ProjectItems, integration/api/odata/ProjectItems({key})
PostWS-ReadChassis,WS-ReadServer,WS-ReadChassisMaterial,WS-ReadServerMaterialintegration/api/odata/ProjectItems

Key(s)
ProjectItemID

ProjectItem Structural Properties

PropertyTypeNullableMandatoryRead-OnlyString lengthMin ValueMax ValuePrecisionMax Dec PlacesIs Only DateDescription
AssetIDEdm.Int32truefalse true N/AN/AN/AN/AN/A
MaterialIDEdm.Int32truefalse true N/AN/AN/AN/AN/A
OrderEdm.Int32falsetrue false N/AN/AN/AN/AN/A
ProjectIDEdm.Int32truefalse true N/AN/AN/AN/AN/A
ProjectItemActionNlyte.Model.ProjectItemActionEnumfalse false
ProjectItemAllocateCriteriaIDEdm.Int32truefalse false N/AN/AN/AN/AN/A
ProjectItemIDEdm.Int32falsefalse true N/AN/AN/AN/AN/A
ProjectItemStatusNlyte.Model.ProjectItemStatusEnumtrue false
TargetAssetIDEdm.Int32truefalse true N/AN/AN/AN/AN/AAsset found after running the auto-allocation criteria against the item

ProjectItem Navigational Properties

PropertyType
AssetNlyte.Model.Asset
MaterialNlyte.Model.Material
ProjectNlyte.Model.Project
ProjectItemAllocateCriteriaNlyte.Model.ProjectItemAllocateCriteria
TargetAssetNlyte.Model.Asset



ProjectItemAllocateCriteria Entity - Entity providing details of allocation criteria values for a specific project item.

Verb(s)Required Permission(s)LinkDescription
GetWS-ReadCabinet,WS-ReadChassis,WS-ReadServer,WS-ReadNetwork,WS-ReadPeripheral,WS-ReadServerHost,WS-ReadNetworkMaterial,WS-ReadCabinetMaterial,WS-ReadChassisMaterial,WS-ReadPeripheralMaterial,WS-ReadServerMaterialintegration/api/odata/ProjectItemAllocateCriterias({key}), integration/api/odata/ProjectItemAllocateCriterias

Key(s)
ProjectItemAllocateCriteriaID

ProjectItemAllocateCriteria Structural Properties

PropertyTypeNullableMandatoryRead-OnlyString lengthMin ValueMax ValuePrecisionMax Dec PlacesIs Only DateDescription
AirflowTypeIDNlyte.Model.AirflowTypeEnumtruefalse false N/AN/AN/AN/AN/ASelected air flow, from the available values defined in the administration area
AutoConnectToKvmSwitchEdm.Booleanfalsefalse false N/AN/AN/AN/AN/A
AutoConnectToPatchPanelsEdm.Booleanfalsefalse false N/AN/AN/AN/AN/A
AutoConnectToPowerSuppliesEdm.Booleanfalsefalse false N/AN/AN/AN/AN/A
BusinessGroupIDEdm.Int32truefalse false N/AN/AN/AN/AN/A
CabinetUsageIDEdm.Int32truefalse false N/AN/AN/AN/AN/A
FindExactMatchForUSpaceEdm.Booleanfalsefalse false N/AN/AN/AN/AN/A
IncludeInAutoAllocationEdm.Booleanfalsefalse false N/AN/AN/AN/AN/A
MountingTypeIDNlyte.Model.MountingTypeEnumtruefalse false N/AN/AN/AN/AN/A
PatchingNetworkSubTypeIDNlyte.Model.NetworkSubTypeEnumtruefalse false N/AN/AN/AN/AN/A
ProjectIDEdm.Int32truefalse true N/AN/AN/AN/AN/A
ProjectItemAllocateCriteriaIDEdm.Int32falsefalse false N/AN/AN/AN/AN/A
ProjectItemIDEdm.Int32falsefalse true N/AN/AN/AN/AN/A
RequiredUHeightEdm.Int32falsefalse false N/AN/AN/AN/AN/A
ReturnCabinetsLinkedToSelectedBusinessGroupOnlyEdm.Booleanfalse false
TargetLocationGroupIDEdm.Int32falsefalse false N/AN/AN/AN/AN/AEntity representing the location used for allocation.
UseAirflowEdm.Booleanfalse false
UseBusinessGroupsEdm.Booleanfalse false
UseCabinetUsageEdm.Booleanfalse false
UseCardConnectionsEdm.Booleanfalse false
UseCompatibleNetworksEdm.Booleanfalse false
UseDataTypeEdm.Booleanfalse false
UseDiversePowerEdm.Booleanfalse false
UseKvmSwitchEdm.Booleanfalse false
UseMountingTypeEdm.Booleanfalse false
UsePatchingNetworkSubTypeEdm.Booleanfalsefalse false N/AN/AN/AN/AN/A
UsePowerConnectionsEdm.Booleanfalse false
UseTotalHeatEdm.Booleanfalse false
UseTotalWeightEdm.Booleanfalse false
UseWarningPoliciesEdm.Booleanfalse false

ProjectItemAllocateCriteria Navigational Properties

PropertyType
ProjectNlyte.Model.Project



ProjectItemHistory Entity - Entity providing details about the allocation history for a project item

Verb(s)Required Permission(s)LinkDescription

Key(s)
ProjectItemID

ProjectItemHistory Structural Properties

PropertyTypeNullableMandatoryRead-OnlyString lengthMin ValueMax ValuePrecisionMax Dec PlacesIs Only DateDescription
AssetIDEdm.Int32falsefalse false N/AN/AN/AN/AN/A
CabinetAssetIDEdm.Int32truefalse false N/AN/AN/AN/AN/A
CabinetAssetNumberEdm.Int32truefalse false N/AN/AN/AN/AN/A
CabinetNameEdm.Stringtruefalse false N/AN/AN/AN/AN/A
DuplicateLocationGroupNameEdm.Stringtruefalse false N/AN/AN/AN/AN/AThe unique location name, having the name as a concatenation of last hierarchical location names.
LocationGroupIDEdm.Int32falsefalse false N/AN/AN/AN/AN/AForeign key identifying the location
MaterialNameEdm.Stringtruefalse false N/AN/AN/AN/AN/A
MaterialNumberEdm.Int32falsefalse false N/AN/AN/AN/AN/A
MaterialTypeEdm.Stringtruefalse false N/AN/AN/AN/AN/A
MaterialTypeIDEdm.Int32falsefalse false N/AN/AN/AN/AN/A
NameEdm.Stringtruefalse false N/AN/AN/AN/AN/A
NumberEdm.Int32falsefalse false N/AN/AN/AN/AN/A
OperationalStatusNlyte.Model.OperationalStatusEnumfalse false
ProjectItemIDEdm.Int32falsefalse false N/AN/AN/AN/AN/A
ProjectItemStatusNlyte.Model.ProjectItemStatusEnumtrue false
RecordStatusNlyte.Model.RecordStatusEnumfalse false
UNumberEdm.Int32truefalse false N/AN/AN/AN/AN/A

ProjectItemHistory Navigational Properties

No navigational properties


ProjectPurpose Entity

Verb(s)Required Permission(s)LinkDescription

Key(s)
ProjectPurposeID

ProjectPurpose Structural Properties

PropertyTypeNullableMandatoryRead-OnlyString lengthMin ValueMax ValuePrecisionMax Dec PlacesIs Only DateDescription
DetailEdm.Stringfalsetrue false 30N/AN/AN/AN/AProject purpose
ProjectPurposeIDEdm.Int32falsefalse false N/AN/AN/AN/AN/A

ProjectPurpose Navigational Properties

No navigational properties


Provider Entity

Verb(s)Required Permission(s)LinkDescription

Key(s)
ID

Provider Structural Properties

PropertyTypeNullableMandatoryRead-OnlyString lengthMin ValueMax ValuePrecisionMax Dec PlacesIs Only DateDescription
FriendlyNameEdm.Stringtruefalse false 512N/AN/AN/AN/A
FullNameEdm.Stringtruefalse false 1000N/AN/AN/AN/A
IDEdm.Guidfalsefalse false N/AN/AN/AN/AN/A
LicenseNameEdm.Stringtruefalse false 512N/AN/AN/AN/A

Provider Navigational Properties

No navigational properties


RealTimeDataProvider Entity

Verb(s)Required Permission(s)LinkDescription
GetWS-ReadRealtimeDataProviderintegration/api/odata/RealTimeDataProviders, integration/api/odata/RealTimeDataProviders({key})
DeleteWS-ModifyRealtimeDataProviderintegration/api/odata/RealTimeDataProviders({key})
PatchWS-ModifyRealtimeDataProviderintegration/api/odata/RealTimeDataProviders({key})
PostWithKeyWS-ModifyRealtimeDataProvider
PostWS-AddRealtimeDataProviderintegration/api/odata/RealTimeDataProviders

Key(s)
ProviderID

RealTimeDataProvider Structural Properties

PropertyTypeNullableMandatoryRead-OnlyString lengthMin ValueMax ValuePrecisionMax Dec PlacesIs Only DateDescription
DescriptionEdm.Stringtruefalse false 512N/AN/AN/AN/A
HeightEdm.Int32falsefalse false N/AN/AN/AN/AN/A
LastUpdatedEdm.DateTimeOffsettruefalse true N/AN/AN/AN/AN/A
ProviderIDEdm.Int32falsefalse true N/AN/AN/AN/AN/A
ShortNameEdm.Stringtruefalse false 12N/AN/AN/AN/A
WidthEdm.Int32falsefalse false N/AN/AN/AN/AN/A

RealTimeDataProvider Navigational Properties

No navigational properties


RealTimeInfo Entity

Verb(s)Required Permission(s)LinkDescription
GetWS-ReadRealtimeInfointegration/api/odata/RealTimeInfo, integration/api/odata/RealTimeInfo({key})
DeleteWS-ModifyRealtimeInfointegration/api/odata/RealTimeInfo({key})
PatchWS-ModifyRealtimeInfointegration/api/odata/RealTimeInfo({key})
PostWithKeyWS-ModifyRealtimeInfo
PostWS-AddRealtimeInfointegration/api/odata/RealTimeInfo

Key(s)
RealtimeInfoID

RealTimeInfo Structural Properties

PropertyTypeNullableMandatoryRead-OnlyString lengthMin ValueMax ValuePrecisionMax Dec PlacesIs Only DateDescription
DefaultUnitEdm.Stringtruefalse false 10N/AN/AN/AN/A
DefaultUnitMultiplyFactorEdm.Doubletruefalse false N/AN/AN/AN/AN/A
DescriptionEdm.Stringtruefalse false 250N/AN/AN/AN/A
LogDataEdm.Booleantruefalse false N/AN/AN/AN/AN/A
NameEdm.Stringtruefalse false 50N/AN/AN/AN/A
RealtimeInfoIDEdm.Int32falsefalse true N/AN/AN/AN/AN/A

RealTimeInfo Navigational Properties

No navigational properties


RealTimeValue Entity

Verb(s)Required Permission(s)LinkDescription

Key(s)
AssetId

RealTimeValue Structural Properties

PropertyTypeNullableMandatoryRead-OnlyString lengthMin ValueMax ValuePrecisionMax Dec PlacesIs Only DateDescription
AssetIdEdm.Int32falsefalse false N/AN/AN/AN/AN/A
ConnectorNoEdm.Int32falsefalse false N/AN/AN/AN/AN/A
ConnectorTypeEdm.Stringtruefalse false N/AN/AN/AN/AN/A
NameEdm.Stringtruefalse false N/AN/AN/AN/AN/A
Phase1ValueEdm.Decimaltruefalse false N/AN/AN/AN/AN/A
Phase2ValueEdm.Decimaltruefalse false N/AN/AN/AN/AN/A
Phase3ValueEdm.Decimaltruefalse false N/AN/AN/AN/AN/A
PositionEdm.Int32falsefalse false N/AN/AN/AN/AN/A
ProviderIdEdm.Int32truefalse false N/AN/AN/AN/AN/A
ProviderNameEdm.Stringtruefalse false N/AN/AN/AN/AN/A
RecordedDateTimeEdm.DateTimeOffsetfalsefalse false N/AN/AN/AN/AN/A
ThreePhaseRecordedDateTimeEdm.DateTimeOffsettruefalse false N/AN/AN/AN/AN/A
UnitEdm.Stringtruefalse false N/AN/AN/AN/AN/A
UnitMultiplyFactorEdm.Doublefalsefalse false N/AN/AN/AN/AN/A
ValueEdm.Decimaltruefalse false N/AN/AN/AN/AN/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)LinkDescription
GetWS-ReadReceptacleintegration/api/odata/Receptacles, integration/api/odata/Receptacles({key})
PatchWS-ModifyReceptacleintegration/api/odata/Receptacles({key})
PostWithKeyWS-ModifyReceptacleintegration/api/odata/Receptacles({key})
DeleteWS-ModifyReceptacleintegration/api/odata/Receptacles({key})
PostWS-AddReceptacleintegration/api/odata/Receptacles

Key(s)
AssetID

Receptacle Structural Properties

PropertyTypeNullableMandatoryRead-OnlyString lengthMin ValueMax ValuePrecisionMax Dec PlacesIs Only DateDescription
CurrentPowerFactorEdm.Decimaltruefalse true N/AN/AN/AN/AN/ARead-only property representing the percentage of power drawn by a PDD asset that is available to its consumers
IsMasterRedundancyDeviceEdm.Booleanfalsefalse false N/AN/AN/AN/AN/AValue inserted by the user
IsUsableEdm.Booleanfalsefalse false N/AN/AN/AN/AN/A
OutputCountEdm.Int32falsefalse true N/AN/AN/AN/AN/A
PhaseARegisterAddressEdm.Stringtruefalse false 255N/AN/AN/AN/A
PhaseBRegisterAddressEdm.Stringtruefalse false 255N/AN/AN/AN/A
PhaseCRegisterAddressEdm.Stringtruefalse false 255N/AN/AN/AN/A
PowerFactorOverrideEdm.Decimaltruefalse false N/A0132Value provided by the user, overriding the CurrentPowerFactor value
RealtimePowerFactorEdm.Decimaltruefalse true N/AN/AN/AN/AN/ARead-only value.
WattsRegisterAddressEdm.Stringtruefalse false 255N/AN/AN/AN/A

Receptacle Navigational Properties

PropertyType
OutputConnectorsCollection(Nlyte.Model.OutputConnector)
ReceptacleMaterialNlyte.Model.ReceptacleMaterial
UtilitiesCollection(Nlyte.Model.Supplier)
WiresCollection(Nlyte.Model.Wire)



ReceptacleMaterial Entity : Material - Material type inheriting properties from the base type

Verb(s)Required Permission(s)LinkDescription
GetWS-ReadReceptacleMaterialintegration/api/odata/ReceptacleMaterials, integration/api/odata/ReceptacleMaterials({key})
PostWS-AddReceptacleMaterialintegration/api/odata/ReceptacleMaterials
PostWithKeyWS-ModifyReceptacleMaterialintegration/api/odata/ReceptacleMaterials({key})
PatchWS-ModifyReceptacleMaterialintegration/api/odata/ReceptacleMaterials({key})
DeleteWS-ModifyReceptacleMaterialintegration/api/odata/ReceptacleMaterials({key})

Key(s)
MaterialID

ReceptacleMaterial Structural Properties

PropertyTypeNullableMandatoryRead-OnlyString lengthMin ValueMax ValuePrecisionMax Dec PlacesIs Only DateDescription
EarthHourPositionEdm.Int32truefalse false N/AN/AN/AN/AN/A
FrequencyRangeEdm.Stringtruefalse false 30N/AN/AN/AN/A
InputPowerTypeIDNlyte.Model.PowerTypeEnumfalsetrue false N/AN/AN/AN/AN/APower type: phased or direct current
MaterialCategoryIDEdm.Int32truefalse false N/AN/AN/AN/AN/A
MaxAmperageEdm.Decimaltruefalse false N/A099999.99983
MaxVoltageEdm.Decimaltruefalse false N/A099999.99983
OutletTypeEdm.Stringtruefalse false 50N/AN/AN/AN/A
PinConfigurationIDNlyte.Model.PinConfigurationEnumtruefalse false N/AN/AN/AN/AN/A
TotalOutletsEdm.Int32falsetrue false N/AN/AN/AN/AN/A
UHeightEdm.Int64falsefalse true N/AN/AN/AN/AN/A

ReceptacleMaterial Navigational Properties

PropertyType
OutputConnectorMaterialsCollection(Nlyte.Model.OutputConnectorMaterial)



RecordListItem Entity : ListItem

Verb(s)Required Permission(s)LinkDescription

Key(s)
ID

RecordListItem Structural Properties

No structural properties

RecordListItem Navigational Properties

No navigational properties


RecordType Entity

Verb(s)Required Permission(s)LinkDescription

Key(s)
RecordTypeID

RecordType Structural Properties

PropertyTypeNullableMandatoryRead-OnlyString lengthMin ValueMax ValuePrecisionMax Dec PlacesIs Only DateDescription
DescriptionEdm.Stringtruefalse false N/AN/AN/AN/AN/A
RecordTypeIDEdm.Int32falsefalse false N/AN/AN/AN/AN/A

RecordType Navigational Properties

PropertyType
ListTypesCollection(Nlyte.Model.ListType)



RecycleAssetControl Entity : FormControl

Verb(s)Required Permission(s)LinkDescription

Key(s)
ID

RecycleAssetControl Structural Properties

No structural properties

RecycleAssetControl Navigational Properties

No navigational properties


RecycleAssetControlValue Entity : FormInstanceControlValue

Verb(s)Required Permission(s)LinkDescription

Key(s)
ID

RecycleAssetControlValue Structural Properties

PropertyTypeNullableMandatoryRead-OnlyString lengthMin ValueMax ValuePrecisionMax Dec PlacesIs Only DateDescription
ProcessedAssetIDsCollection(Edm.Int32)falsefalse false N/AN/AN/AN/AN/A

RecycleAssetControlValue Navigational Properties

No navigational properties


RenameAssetControl Entity : FormControl

Verb(s)Required Permission(s)LinkDescription

Key(s)
ID

RenameAssetControl Structural Properties

No structural properties

RenameAssetControl Navigational Properties

No navigational properties


RenameAssetControlValue Entity : FormInstanceControlValue

Verb(s)Required Permission(s)LinkDescription

Key(s)
ID

RenameAssetControlValue Structural Properties

No structural properties

RenameAssetControlValue Navigational Properties

No navigational properties


ReplaceFormResult Entity

Verb(s)Required Permission(s)LinkDescription

Key(s)
ID

ReplaceFormResult Structural Properties

PropertyTypeNullableMandatoryRead-OnlyString lengthMin ValueMax ValuePrecisionMax Dec PlacesIs Only DateDescription
IDEdm.Int32falsefalse false N/AN/AN/AN/AN/A

ReplaceFormResult Navigational Properties

PropertyType
ReplacedProcessNlyte.Model.Process
WarningsCollection(Nlyte.Model.Warning)



ReportingTag Entity

Verb(s)Required Permission(s)LinkDescription
PostWS-AddFormintegration/api/odata/ReportingTags

Key(s)
ID

ReportingTag Structural Properties

PropertyTypeNullableMandatoryRead-OnlyString lengthMin ValueMax ValuePrecisionMax Dec PlacesIs Only DateDescription
IDEdm.Int32falsefalse true N/AN/AN/AN/AN/A
NameEdm.Stringfalsetrue false 50N/AN/AN/AN/A

ReportingTag Navigational Properties

No navigational properties


Resource Entity

Verb(s)Required Permission(s)LinkDescription

Key(s)
ResourceID

Resource Structural Properties

PropertyTypeNullableMandatoryRead-OnlyString lengthMin ValueMax ValuePrecisionMax Dec PlacesIs Only DateDescription
ClientUserGUIDEdm.Stringtruefalse false 100N/AN/AN/AN/A
CompanyEdm.Stringtruefalse false 50N/AN/AN/AN/A
CompanyPhoneNumberEdm.Stringtruefalse false 50N/AN/AN/AN/A
CultureIDEdm.Int32truefalse false N/AN/AN/AN/AN/A
DepartmentEdm.Stringtruefalse false 50N/AN/AN/AN/A
DepartmentPhoneNumberEdm.Stringtruefalse false 50N/AN/AN/AN/A
EmailEdm.Stringtruefalse false 254N/AN/AN/AN/A
ForenameEdm.Stringfalsetrue false 50N/AN/AN/AN/A
FullNameEdm.Stringtruefalse false N/AN/AN/AN/AN/A
ManagerResourceIDEdm.Int32truefalse false N/AN/AN/AN/AN/A
MeasurementSystemIDEdm.Int32truefalse false N/AN/AN/AN/AN/A
MiddlenameEdm.Stringfalsetrue false 50N/AN/AN/AN/A
MobileNumberEdm.Stringtruefalse false 50N/AN/AN/AN/A
PhoneNumberEdm.Stringfalsetrue false 50N/AN/AN/AN/A
ResourceIDEdm.Int32truefalse false N/AN/AN/AN/AN/A
RFIDCardIDEdm.Stringtruefalse false 50N/AN/AN/AN/A
SurnameEdm.Stringfalsetrue false 50N/AN/AN/AN/A
TimeZoneEdm.Doubletruefalse false N/AN/AN/AN/AN/A
TitleEdm.Stringtruefalse false 10N/AN/AN/AN/A

Resource Navigational Properties

PropertyType
CultureNlyte.Model.Culture
MeasurementSystemNlyte.Model.MeasurementSystem
ParentNlyte.Model.Resource



Room Entity : RoomDrawingInfo

Verb(s)Required Permission(s)LinkDescription
GetWS-ReadRoomPlanintegration/api/odata/Rooms, integration/api/odata/Rooms({key})
PatchWS-ModifyRoomPlan
PutWS-ModifyRoomPlanintegration/api/odata/Rooms({key})
PostWS-ModifyRoomPlan

Key(s)
ID

Room Structural Properties

PropertyTypeNullableMandatoryRead-OnlyString lengthMin ValueMax ValuePrecisionMax Dec PlacesIs Only DateDescription
AliasEdm.Stringtruefalse true 255N/AN/AN/AN/A
CoolingLimitEdm.Decimaltruefalse false N/A09999999.999103
CoolingMaximumEdm.Decimaltruefalse false N/A09999999.999103
CoolingThresholdEdm.Decimaltruefalse false N/A09999999.999103
GridIdEdm.Int32truefalse true N/AN/AN/AN/AN/A
HeatLimitEdm.Decimaltruefalse false N/A09999999.999103
HeatMaximumEdm.Decimaltruefalse false N/A09999999.999103
HeatThresholdEdm.Decimaltruefalse false N/A09999999.999103
ImageEdm.Stringtruefalse false N/AN/AN/AN/AN/A
NominalPowerEdm.Decimaltruefalse false N/A09999999.999103
WeightLimitEdm.Decimaltruefalse false N/A09999999.9999114
WeightMaximumEdm.Decimaltruefalse false N/A09999999.9999114
WeightThresholdEdm.Decimaltruefalse false N/A09999999.9999114

Room Navigational Properties

PropertyType
AreasCollection(Nlyte.Model.Area)
GridNlyte.Model.Grid
MeasurementsCollection(Nlyte.Model.Measurement)
RoomItemsCollection(Nlyte.Model.RoomItem)
WallsCollection(Nlyte.Model.Wall)
ZonesCollection(Nlyte.Model.Zone)



RoomDrawingInfo Entity

Verb(s)Required Permission(s)LinkDescription
GetWS-ReadRoomPlan
PatchWS-ModifyRoomPlan
PutWS-ModifyRoomPlan
PostWS-ModifyRoomPlan

Key(s)
ID

RoomDrawingInfo Structural Properties

PropertyTypeNullableMandatoryRead-OnlyString lengthMin ValueMax ValuePrecisionMax Dec PlacesIs Only DateDescription
AmbientTemperatureEdm.Decimalfalsefalse false N/AN/AN/AN/AN/A
CavityHeightEdm.Decimalfalsefalse false N/A099999.9144
CavityMaterialNlyte.Model.FloorPlannerMaterialtrue false
CeilingCavityHeightEdm.Decimalfalsefalse false N/A099999.9144
ContainsContentEdm.Booleanfalsefalse false N/AN/AN/AN/AN/A
FloorCavityHeightEdm.Decimalfalsefalse false N/A099999.9144
FloorIdEdm.Int32truefalse true N/AN/AN/AN/AN/A
FloorLocationGroupIdEdm.Int32falsefalse true N/AN/AN/AN/AN/A
IDEdm.Int32falsefalse false N/AN/AN/AN/AN/A
LatitudeEdm.Decimaltruefalse true N/AN/AN/AN/AN/A
LengthEdm.Decimalfalsefalse false N/A09999999.9144
LocationGroupIDEdm.Int32truefalse false N/AN/AN/AN/AN/A
LocationPurposeEdm.Stringtruefalse true 255N/AN/AN/AN/A
LongitudeEdm.Decimaltruefalse true N/AN/AN/AN/AN/A
NameEdm.Stringtruefalse true 50N/AN/AN/AN/A
SaveActionNlyte.Model.SaveActionEnumfalsefalse false N/AN/AN/AN/AN/A
TotalAreaOverrideEdm.Decimaltruefalse false N/A01000000000000000194
UsedAreaEdm.Decimalfalsefalse true N/AN/AN/AN/AN/A
WidthEdm.Decimalfalsefalse false N/A09999999.9144
XEdm.Decimalfalsefalse false N/AN/AN/AN/AN/A
YEdm.Decimalfalsefalse false N/AN/AN/AN/AN/A

RoomDrawingInfo Navigational Properties

PropertyType
FloorNlyte.Model.Floor
LocationGroupNlyte.Model.LocationGroup
RoomLayersCollection(Nlyte.Model.RoomLayer)



RoomItem Entity

Verb(s)Required Permission(s)LinkDescription
GetWS-ReadRoomPlan
PatchWS-ModifyRoomPlan
PutWS-ModifyRoomPlan
DeleteWS-ModifyRoomPlan
PostWS-ModifyRoomPlan

Key(s)
ID

RoomItem Structural Properties

PropertyTypeNullableMandatoryRead-OnlyString lengthMin ValueMax ValuePrecisionMax Dec PlacesIs Only DateDescription
DisplayPropertiesIDEdm.Int32truefalse true N/AN/AN/AN/AN/A
IDEdm.Int32falsefalse false N/AN/AN/AN/AN/A
LayerIDEdm.Int32truetrue false N/AN/AN/AN/AN/A
LocationGroupIDEdm.Int32truefalse false N/AN/AN/AN/AN/A
MirrorXEdm.Booleanfalsefalse false N/AN/AN/AN/AN/A
MirrorYEdm.Booleanfalsefalse false N/AN/AN/AN/AN/A
RotationEdm.Int32falsefalse false N/AN/AN/AN/AN/A
SaveActionNlyte.Model.SaveActionEnumfalsefalse false N/AN/AN/AN/AN/A
TemplateIDEdm.Int32truefalse true N/AN/AN/AN/AN/AThe associated template
XEdm.Decimalfalsefalse false N/AN/AN/AN/AN/A
YEdm.Decimalfalsefalse false N/AN/AN/AN/AN/A
ZEdm.Decimalfalsefalse false N/AN/AN/AN/AN/A

RoomItem Navigational Properties

PropertyType
AssetTemplateNlyte.Model.AssetTemplate
DisplayPropertiesNlyte.Model.DisplayProperties
LayerNlyte.Model.RoomLayer
LocationGroupNlyte.Model.LocationGroup
RoomNlyte.Model.Room



RoomItemAsset Entity : RoomItem

Verb(s)Required Permission(s)LinkDescription

Key(s)
ID

RoomItemAsset Structural Properties

PropertyTypeNullableMandatoryRead-OnlyString lengthMin ValueMax ValuePrecisionMax Dec PlacesIs Only DateDescription
AssetIDEdm.Int32falsetrue false N/AN/AN/AN/AN/A
AssetNameEdm.Stringtruefalse true N/AN/AN/AN/AN/A
AssetNumberEdm.Int32falsefalse true N/AN/AN/AN/AN/A
CachedGridRefOffsetXEdm.Decimalfalsefalse false N/AN/AN/AN/AN/A
CachedGridRefOffsetYEdm.Decimalfalsefalse false N/AN/AN/AN/AN/A
FootPrintBackEdm.Decimaltruefalse false N/AN/AN/AN/AN/A
FootPrintFrontEdm.Decimaltruefalse false N/AN/AN/AN/AN/A
FootPrintLeftEdm.Decimaltruefalse false N/AN/AN/AN/AN/A
FootPrintRightEdm.Decimaltruefalse false N/AN/AN/AN/AN/A
GridReferenceColumnEdm.Stringtruefalse false N/AN/AN/AN/AN/AGrid reference information, defined in the room planner
GridReferenceRowEdm.Stringtruefalse false N/AN/AN/AN/AN/AGrid reference information, defined in the room planner
HeatingLimitEdm.Doubletruefalse false N/AN/AN/AN/AN/A
HeatThresholdEdm.Doubletruefalse false N/AN/AN/AN/AN/A
InternalRefPointXEdm.Decimalfalsefalse false N/AN/AN/AN/AN/A
InternalRefPointYEdm.Decimalfalsefalse false N/AN/AN/AN/AN/A
LengthEdm.Doublefalsefalse false N/AN/AN/AN/AN/A
MaterialSubtypeIdEdm.Int32truefalse true N/AN/AN/AN/AN/A
MaterialTypeEdm.Stringtruefalse true N/AN/AN/AN/AN/A
MaterialTypeIdEdm.Int32falsefalse true N/AN/AN/AN/AN/A
OperationalStatusNlyte.Model.OperationalStatusEnumfalsefalse true N/AN/AN/AN/AN/A
RecordStatusNlyte.Model.RecordStatusEnumfalsefalse true N/AN/AN/AN/AN/A
WeightLimitEdm.Doubletruefalse false N/A099999999999999.9999184
WeightMaximumEdm.Doubletruefalse false N/A099999999999999.9999184
WeightThresholdEdm.Doubletruefalse false N/A099999999999999.9999184
WidthEdm.Doublefalsefalse false N/AN/AN/AN/AN/A
WorkableFootPrintFrontEdm.Doublefalsefalse true N/AN/AN/AN/AN/A
WorkableFootPrintLeftEdm.Doublefalsefalse true N/AN/AN/AN/AN/A
WorkableFootPrintRearEdm.Doublefalsefalse true N/AN/AN/AN/AN/A
WorkableFootPrintRightEdm.Doublefalsefalse true N/AN/AN/AN/AN/A

RoomItemAsset Navigational Properties

No navigational properties


RoomItemSimple Entity : RoomItem

Verb(s)Required Permission(s)LinkDescription

Key(s)
ID

RoomItemSimple Structural Properties

PropertyTypeNullableMandatoryRead-OnlyString lengthMin ValueMax ValuePrecisionMax Dec PlacesIs Only DateDescription
LengthEdm.Doublefalsefalse false N/AN/AN/AN/AN/A
NameEdm.Stringtruetrue false 250N/AN/AN/AN/A
RoomItemCategoryIdEdm.Int32falsefalse false N/AN/AN/AN/AN/A
WidthEdm.Doublefalsefalse false N/AN/AN/AN/AN/A

RoomItemSimple Navigational Properties

No navigational properties


RoomLayer Entity : Layer

Verb(s)Required Permission(s)LinkDescription
GetWS-ReadRoomPlan
PatchWS-ModifyRoomPlan
PutWS-ModifyRoomPlan
DeleteWS-ModifyRoomPlan
PostWS-ModifyRoomPlan

Key(s)
ID

RoomLayer Structural Properties

PropertyTypeNullableMandatoryRead-OnlyString lengthMin ValueMax ValuePrecisionMax Dec PlacesIs Only DateDescription
ContentChangedEdm.Booleanfalsefalse false N/AN/AN/AN/AN/AAllows changes to items (RoomItems, Areas, Measurements, Walls, Zones) within a Locked or Invisible Layer
RoomIdEdm.Int32truefalse true N/AN/AN/AN/AN/A

RoomLayer Navigational Properties

PropertyType
RoomNlyte.Model.Room



RPPPDUMaterial Entity : PDUMaterial

Verb(s)Required Permission(s)LinkDescription
GetWS-ReadPDUMaterialintegration/api/odata/RPPPDUMaterials, integration/api/odata/RPPPDUMaterials({key})
PostWS-AddPDUMaterialintegration/api/odata/RPPPDUMaterials
PostWithKeyWS-ModifyPDUMaterial
PatchWS-ModifyPDUMaterialintegration/api/odata/RPPPDUMaterials({key})
DeleteWS-ModifyPDUMaterialintegration/api/odata/RPPPDUMaterials({key})

Key(s)
MaterialID

RPPPDUMaterial Structural Properties

No structural properties

RPPPDUMaterial Navigational Properties

No navigational properties


Scheme Entity

Verb(s)Required Permission(s)LinkDescription

Key(s)
SchemeID

Scheme Structural Properties

PropertyTypeNullableMandatoryRead-OnlyString lengthMin ValueMax ValuePrecisionMax Dec PlacesIs Only DateDescription
LabelEdm.Stringfalsetrue false 256N/AN/AN/AN/A
SchemeIDEdm.Int32falsefalse false N/AN/AN/AN/AN/A

Scheme Navigational Properties

PropertyType
ColoursCollection(Nlyte.Model.SchemeColour)



SchemeColour Entity

Verb(s)Required Permission(s)LinkDescription

Key(s)
ColourID

SchemeColour Structural Properties

PropertyTypeNullableMandatoryRead-OnlyString lengthMin ValueMax ValuePrecisionMax Dec PlacesIs Only DateDescription
ColourEdm.Stringfalsetrue false 20N/AN/AN/AN/A
ColourIDEdm.Int32falsefalse false N/AN/AN/AN/AN/A
ResultEdm.Int32falsefalse false N/AN/AN/AN/AN/A
SchemeIDEdm.Int32truefalse false N/AN/AN/AN/AN/A

SchemeColour Navigational Properties

PropertyType
SchemeNlyte.Model.Scheme



Server Entity : Asset - Asset created from a material of type server, entity inheriting the Nlyte.Model.Asset entity

Verb(s)Required Permission(s)LinkDescription
GetWS-ReadServerintegration/api/odata/Servers, integration/api/odata/Servers({key})
PatchWS-ModifyServerintegration/api/odata/Servers({key})
PostWithKeyWS-ModifyServerintegration/api/odata/Servers({key})
DeleteWS-ModifyServerintegration/api/odata/Servers({key})
PostWS-AddServerintegration/api/odata/Servers

Key(s)
AssetID

Server Structural Properties

PropertyTypeNullableMandatoryRead-OnlyString lengthMin ValueMax ValuePrecisionMax Dec PlacesIs Only DateDescription
AuditDateEdm.DateTimeOffsettruefalse false N/AN/AN/AN/AN/A
AuditStatusCorrectEdm.Booleantruefalse false N/AN/AN/AN/AN/A
ChassisMountedAssetMapIDEdm.Int32truefalse true N/AN/AN/AN/AN/A
FQDNEdm.Stringtruefalse false 255N/AN/AN/AN/A
HardwareSupportWeightingEdm.Doubletruefalse true N/AN/AN/AN/AN/A
LastAuditorAccountIDEdm.Int32truefalse false N/AN/AN/AN/AN/A
ManagementSoftwareIDEdm.Int32truefalse false N/AN/AN/AN/AN/A
OperatingSystemIDEdm.Int32truefalse false N/AN/AN/AN/AN/A
ProjectIDEdm.Int32true false
StrategyIDEdm.Int32true false
TotalPlugsEdm.Int32falsefalse true N/AN/AN/AN/AN/A
TotalSystemSpaceEdm.Int32truefalse false N/AN/AN/AN/AN/A
TrancheNumberEdm.Int32truefalse false N/AN/AN/AN/AN/A

Server Navigational Properties

PropertyType
ChassisMountedAssetMapNlyte.Model.ChassisMountedAssetMap
InputConnectorsCollection(Nlyte.Model.InputConnector)
KvmSwitchPortConsumerLinksCollection(Nlyte.Model.KVMSwitchPortConsumerLink)
ManagementSoftwareNlyte.Model.Software
OperatingSystemNlyte.Model.Software
PeripheralsCollection(Nlyte.Model.PeripheralAssetLink)
PhysicalPartitionsCollection(Nlyte.Model.PhysicalPartition)
ProjectNlyte.Model.ProjectPurpose
ServerHostsCollection(Nlyte.Model.ServerHost)
ServerMaterialNlyte.Model.ServerMaterial
StrategyNlyte.Model.ProjectAction



ServerHost Entity - Entity providing details about a host

Verb(s)Required Permission(s)LinkDescription
GetWS-ReadServerHostintegration/api/odata/ServerHosts, integration/api/odata/ServerHosts({key})
PatchWS-ModifyServerHostintegration/api/odata/ServerHosts({key})
PostWithKeyWS-ModifyServerHostintegration/api/odata/ServerHosts({key})
DeleteWS-ModifyServerHostintegration/api/odata/ServerHosts({key})
PostWS-AddServerHostintegration/api/odata/ServerHosts

Key(s)
ServerHostID

ServerHost Structural Properties

PropertyTypeNullableMandatoryRead-OnlyString lengthMin ValueMax ValuePrecisionMax Dec PlacesIs Only DateDescription
AliasEdm.Stringtruefalse false 30N/AN/AN/AN/A
ApprovalGroupEdm.Stringtruefalse false 60N/AN/AN/AN/A
AssignmentGroupEdm.Stringtruefalse false 60N/AN/AN/AN/A
AvailabilityZoneEdm.Stringtruefalse false 250N/AN/AN/AN/A
BusinessUnitEdm.Stringtruefalse false 60N/AN/AN/AN/A
ChangeControlEdm.Stringtruefalse false 60N/AN/AN/AN/A
ClusterEdm.Stringtruefalse false 50N/AN/AN/AN/A
ClusterVIPEdm.Stringtruefalse false 50N/AN/AN/AN/A
CommentsEdm.Stringtruefalse false 800N/AN/AN/AN/A
CostCenterEdm.Stringtruefalse false 255N/AN/AN/AN/A
CPUAllocatedEdm.Doubletruefalse false N/AN/AN/AN/AN/A
CreationDateEdm.DateTimeOffsettruefalse true N/AN/AN/AN/AN/AIsOnlyDate
CriticalityEdm.Stringtruefalse false 60N/AN/AN/AN/A
DataSizeEdm.Doublefalsefalse false N/A099999999999.99132
DBBackupEdm.Stringtruefalse false 60N/AN/AN/AN/A
DiskAllocatedEdm.Doublefalsefalse false N/AN/AN/AN/AN/A
EngineeringDomainEdm.Stringtruefalse false 60N/AN/AN/AN/A
FunctionalUseIDEdm.Int32truefalse false N/AN/AN/AN/AN/AFunctional Usage defined in the administration area
HasRemoteAccessEdm.Booleanfalsefalse false N/AN/AN/AN/AN/A
HostGroupEdm.Stringtruefalse false 60N/AN/AN/AN/A
HostNameEdm.Stringtruetrue false 80N/AN/AN/AN/A
HostNumberEdm.Int32truefalse true N/AN/AN/AN/AN/A
InstanceStatusEdm.Stringtruefalse false 250N/AN/AN/AN/A
InstanceTypeEdm.Stringtruefalse false 250N/AN/AN/AN/A
IsVirtualEdm.Booleantruefalse false N/AN/AN/AN/AN/A
LastAssetExplorerScanDateEdm.DateTimeOffsettruefalse false N/AN/AN/AN/AN/A
LeaderNameEdm.Stringtruefalse false 250N/AN/AN/AN/A
LocationGroupIDEdm.Int32truefalse false N/AN/AN/AN/AN/AForeign key identifying the host location
LogicalPartitionTypeIDEdm.Int32truefalse false N/AN/AN/AN/AN/A
MemoryAllocatedEdm.Doubletruefalse false N/AN/AN/AN/AN/A
MonthlyHostingCostEdm.Decimaltruefalse false N/A09999999999.9999144
OperatingSystemSoftwareIDEdm.Int32truefalse false N/AN/AN/AN/AN/A
OperationalDateEdm.DateTimeOffsettruefalse false N/AN/AN/AN/AN/AIsOnlyDate
OperationalSupportWeightingPercentEdm.Bytefalsefalse false N/AN/AN/AN/AN/A
OperationalUseIDEdm.Int32truefalse false N/AN/AN/AN/AN/AOperational Usage defined in the administration area
OSBackupEdm.Stringtruefalse false 60N/AN/AN/AN/A
PhysicalPartitionIDEdm.Int32truefalse false N/AN/AN/AN/AN/ALogical partition defined in the administration area, associated to the current host on the parent equipment configuration
PONumberEdm.Stringtruefalse false 255N/AN/AN/AN/A
PrimaryOwnerEdm.Stringtruefalse false 60N/AN/AN/AN/A
PRNumberEdm.Stringtruefalse false 255N/AN/AN/AN/A
RecordStatusNlyte.Model.RecordStatusEnumfalsetrue false N/AN/AN/AN/AN/A
RegulatoryEdm.Booleanfalsefalse false N/AN/AN/AN/AN/A
RiskEdm.Stringtruefalse false 60N/AN/AN/AN/A
SAPAssetNumberEdm.Stringtruefalse false 255N/AN/AN/AN/A
SecondaryOwnerEdm.Stringtruefalse false 60N/AN/AN/AN/A
SerialUUIDEdm.Stringtruefalse false 150N/AN/AN/AN/ASerial UUID
ServerAssetIDEdm.Int32truefalse false N/AN/AN/AN/AN/A
ServerHostComplianceIDEdm.Int32truefalse false N/AN/AN/AN/AN/A
ServerHostIDEdm.Int32falsefalse false N/AN/AN/AN/AN/A
ServerHostOperationalStatusIDNlyte.Model.OperationalStatusEnumfalsetrue false N/AN/AN/AN/AN/AReflects 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.
ServiceLeadersEdm.Stringtruefalse false 250N/AN/AN/AN/A
SubStatusIDEdm.Int32truefalse false N/AN/AN/AN/AN/ASub-status defined in the administration area.
TierEdm.Stringtruefalse false 60N/AN/AN/AN/A
UtilisationPercentEdm.Bytefalsefalse false N/AN/AN/AN/AN/A
VMCreationDateTimeEdm.DateTimeOffsettruefalse false N/AN/AN/AN/AN/A
VMIPAddressEdm.Stringtruefalse false 15N/AN/AN/AN/A
VMLastMoveDateTimeEdm.DateTimeOffsettruefalse false N/AN/AN/AN/AN/A
VMLastUpdateDateTimeEdm.DateTimeOffsettruefalse false N/AN/AN/AN/AN/AVM Last Update Datetime
VMNameEdm.Stringtruefalse false 250N/AN/AN/AN/A

ServerHost Navigational Properties

PropertyType
AssetNlyte.Model.Asset
AssetMountingNlyte.Model.AssetMounting
BusinessApplicationServerHostsCollection(Nlyte.Model.BusinessApplicationServerHostMap)
FilesCollection(Nlyte.Model.HostFile)
FunctionalUseNlyte.Model.FunctionalUse
HostMappingsCollection(Nlyte.Model.HostMapping)
InternalEquipmentItemUtilisationsCollection(Nlyte.Model.InternalEquipmentItemUtilisation)
LocationGroupNlyte.Model.LocationGroup
LogicalPartitionTypeNlyte.Model.LogicalPartitionType
NotesCollection(Nlyte.Model.HostNote)
OperatingSystemSoftwareNlyte.Model.Software
OperationalUseNlyte.Model.OperationalUse
OwnershipCollection(Nlyte.Model.ServerHostBusinessGroupMap)
PhysicalPartitionNlyte.Model.PhysicalPartition
ServerHostComplianceNlyte.Model.ServerHostCompliance
ServerHostIPAddressesCollection(Nlyte.Model.ServerHostIPAddressMap)
ServerHostSoftwaresCollection(Nlyte.Model.ServerHostSoftwareMap)
SubStatusNlyte.Model.SubStatus
SupportCollection(Nlyte.Model.ServerHostSupportGroupMap)



ServerHostBusinessGroupMap Entity

Verb(s)Required Permission(s)LinkDescription
GetWS-ReadServerHostBusinessGroupMap
PatchWS-ModifyServerHostBusinessGroupMap
DeleteWS-ModifyServerHostBusinessGroupMap
PostWS-AddServerHostBusinessGroupMap
PostWithKeyWS-ModifyServerHostBusinessGroupMap

Key(s)
ID

ServerHostBusinessGroupMap Structural Properties

PropertyTypeNullableMandatoryRead-OnlyString lengthMin ValueMax ValuePrecisionMax Dec PlacesIs Only DateDescription
BusinessGroupIDEdm.Int32truefalse false N/AN/AN/AN/AN/A
BusinessGroupNameEdm.Stringtruefalse false 255N/AN/AN/AN/A
BusinessGroupNumberEdm.Int32truefalse false N/AN/AN/AN/AN/A
ColourIndexEdm.Int32truefalse false N/AN/AN/AN/AN/A
CultureIDEdm.Int32truefalse false N/AN/AN/AN/AN/A
DescriptionEdm.Stringtruefalse false 255N/AN/AN/AN/A
EmailAddressEdm.Stringtruefalse false 254N/AN/AN/AN/A
IDEdm.Int32falsefalse false N/AN/AN/AN/AN/A
OwnershipPercentageEdm.Int32falsefalse false N/AN/AN/AN/AN/A
ParentBusinessGroupIDEdm.Int32truefalse false N/AN/AN/AN/AN/A
RecordStatusEdm.Int32falsefalse false N/AN/AN/AN/AN/A
ServerHostIDEdm.Int32truefalse false N/AN/AN/AN/AN/A
TelephoneNumberEdm.Stringtruefalse false 30N/AN/AN/AN/A

ServerHostBusinessGroupMap Navigational Properties

PropertyType
BusinessGroupNlyte.Model.BusinessGroup
CultureNlyte.Model.Culture
ParentNlyte.Model.BusinessGroup
ServerHostNlyte.Model.ServerHost



ServerHostCompliance Entity

Verb(s)Required Permission(s)LinkDescription

Key(s)
ServerHostComplianceID

ServerHostCompliance Structural Properties

PropertyTypeNullableMandatoryRead-OnlyString lengthMin ValueMax ValuePrecisionMax Dec PlacesIs Only DateDescription
DetailEdm.Stringfalsetrue false 50N/AN/AN/AN/AServer host compliance
ServerHostComplianceIDEdm.Int32falsefalse false N/AN/AN/AN/AN/A

ServerHostCompliance Navigational Properties

No navigational properties


ServerHostIPAddressMap Entity

Verb(s)Required Permission(s)LinkDescription
GetWS-ReadServerHostIPAddressMap
PatchWS-ModifyServerHostIPAddressMap
DeleteWS-ModifyServerHostIPAddressMap
PostWS-AddServerHostIPAddressMap
PostWithKeyWS-ModifyServerHostIPAddressMap

Key(s)
ServerHostIPAddressMapID

ServerHostIPAddressMap Structural Properties

PropertyTypeNullableMandatoryRead-OnlyString lengthMin ValueMax ValuePrecisionMax Dec PlacesIs Only DateDescription
IPAddressIDEdm.Int32truefalse false N/AN/AN/AN/AN/A
ServerHostIDEdm.Int32truefalse false N/AN/AN/AN/AN/A
ServerHostIPAddressMapIDEdm.Int32falsefalse false N/AN/AN/AN/AN/A

ServerHostIPAddressMap Navigational Properties

PropertyType
IPAddressNlyte.Model.IPAddress
ServerHostNlyte.Model.ServerHost



ServerHostSoftwareMap Entity - Entity providing details on the association between a host and a software

Verb(s)Required Permission(s)LinkDescription
GetWS-ReadHostSoftwareMap
PostWS-AddHostSoftwareMap
PatchWS-ModifyHostSoftwareMap
PostWithKeyWS-ModifyHostSoftwareMap
DeleteWS-ModifyHostSoftwareMap

Key(s)
ServerHostSoftwareMapID

ServerHostSoftwareMap Structural Properties

PropertyTypeNullableMandatoryRead-OnlyString lengthMin ValueMax ValuePrecisionMax Dec PlacesIs Only DateDescription
IsManagementSoftwareEdm.Booleanfalsefalse false N/AN/AN/AN/AN/A
IsOperatingSystemEdm.Booleanfalsefalse false N/AN/AN/AN/AN/A
IsWebApplicationEdm.Booleanfalsefalse false N/AN/AN/AN/AN/A
RecordStatusEdm.Bytefalsefalse false N/AN/AN/AN/AN/A
ServerHostIDEdm.Int32truefalse false N/AN/AN/AN/AN/A
ServerHostSoftwareMapIDEdm.Int32falsefalse false N/AN/AN/AN/AN/A
SoftwareIDEdm.Int32falsefalse false N/AN/AN/AN/AN/A
SoftwareManufacturerIDEdm.Int32truefalse false N/AN/AN/AN/AN/AThe manufacturer ID, used from the predefined list of manufacturers.
SoftwareNameEdm.Stringtruefalse false 100N/AN/AN/AN/A
SoftwareNumberEdm.Int32falsefalse false N/AN/AN/AN/AN/A
SoftwareTypeIDEdm.Int32truefalse false N/AN/AN/AN/AN/A
VersionEdm.Stringtruefalse false 30N/AN/AN/AN/A

ServerHostSoftwareMap Navigational Properties

PropertyType
ServerHostNlyte.Model.ServerHost
SoftwareManufacturerNlyte.Model.SoftwareManufacturer
SoftwareTypeNlyte.Model.SoftwareType



ServerHostSupportGroupMap Entity

Verb(s)Required Permission(s)LinkDescription
GetWS-ReadServerHostSupportGroupMap
PatchWS-ModifyServerHostSupportGroupMap
DeleteWS-ModifyServerHostSupportGroupMap
PostWS-AddServerHostSupportGroupMap
PostWithKeyWS-ModifyServerHostSupportGroupMap

Key(s)
ID

ServerHostSupportGroupMap Structural Properties

PropertyTypeNullableMandatoryRead-OnlyString lengthMin ValueMax ValuePrecisionMax Dec PlacesIs Only DateDescription
ColourIndexEdm.Int32truefalse false N/AN/AN/AN/AN/A
CultureIDEdm.Int32truefalse false N/AN/AN/AN/AN/A
DescriptionEdm.Stringtruefalse false 255N/AN/AN/AN/A
EmailAddressEdm.Stringtruefalse false 254N/AN/AN/AN/A
IDEdm.Int32falsefalse false N/AN/AN/AN/AN/A
ParentSupportGroupIDEdm.Int32truefalse false N/AN/AN/AN/AN/A
RecordStatusEdm.Int32falsefalse false N/AN/AN/AN/AN/A
ServerHostIDEdm.Int32truefalse false N/AN/AN/AN/AN/A
SupportGroupIDEdm.Int32truefalse false N/AN/AN/AN/AN/A
SupportGroupNameEdm.Stringtruefalse false 255N/AN/AN/AN/A
SupportGroupNumberEdm.Int32truefalse false N/AN/AN/AN/AN/A
SupportPercentageEdm.Int32falsefalse false N/AN/AN/AN/AN/A
TelephoneNumberEdm.Stringtruefalse false 30N/AN/AN/AN/A

ServerHostSupportGroupMap Navigational Properties

PropertyType
CultureNlyte.Model.Culture
ParentNlyte.Model.SupportGroup
ServerHostNlyte.Model.ServerHost
SupportGroupNlyte.Model.SupportGroup



ServerMaterial Entity : Material - Material type inheriting properties from the base type

Verb(s)Required Permission(s)LinkDescription
GetWS-ReadServerMaterialintegration/api/odata/ServerMaterials, integration/api/odata/ServerMaterials({key})
PostWS-AddServerMaterialintegration/api/odata/ServerMaterials
PostWithKeyWS-ModifyServerMaterialintegration/api/odata/ServerMaterials({key})
PatchWS-ModifyServerMaterialintegration/api/odata/ServerMaterials({key})
DeleteWS-ModifyServerMaterialintegration/api/odata/ServerMaterials({key})

Key(s)
MaterialID

ServerMaterial Structural Properties

PropertyTypeNullableMandatoryRead-OnlyString lengthMin ValueMax ValuePrecisionMax Dec PlacesIs Only DateDescription
CalculatedMpafPowerConsumptionEdm.Decimaltruefalse true N/AN/AN/AN/AN/ARead-only property, value provided by the service based on the PublishedPowerConsumption and the MpafOverride
ConsumerPowerFactorEdm.Decimalfalsefalse true N/AN/AN/AN/AN/ARead-only property representing the percentage of power drawn by a PDD material that is available to its asset consumers
MountingTypeIDNlyte.Model.MountingTypeEnumtruefalse false N/AN/AN/AN/AN/A
MpafOverrideEdm.Decimaltruefalse false N/A0.00199963Value inserted by the user, while the material is in Planned status
NumberOfColumnsEdm.Int32truefalse false N/AN/AN/AN/AN/A
NumberOfRowsEdm.Int32truefalse false N/AN/AN/AN/AN/A
UHeightEdm.Int64falsefalse true N/AN/AN/AN/AN/A

ServerMaterial Navigational Properties

PropertyType
InputConnectorMaterialsCollection(Nlyte.Model.InputConnectorMaterial)



ServiceRequest Entity

Verb(s)Required Permission(s)LinkDescription
GetWS-ReadServiceRequestintegration/api/odata/ServiceRequests, integration/api/odata/ServiceRequests({key})
PostWS-AddServiceRequestintegration/api/odata/ServiceRequests
PatchWS-ModifyServiceRequestintegration/api/odata/ServiceRequests({key})
PutWS-ModifyServiceRequestintegration/api/odata/ServiceRequests({key})

Key(s)
ID

ServiceRequest Structural Properties

PropertyTypeNullableMandatoryRead-OnlyString lengthMin ValueMax ValuePrecisionMax Dec PlacesIs Only DateDescription
AgingInMinsEdm.Int64truefalse true N/AN/AN/AN/AN/A
ChargeToAssigneeIDEdm.Int32truefalse false N/AN/AN/AN/AN/A
ChargeToGroupsOfResourceIDEdm.Int32truefalse true N/AN/AN/AN/AN/A
DateAgingLastUpdatedEdm.DateTimeOffsettruefalse true N/AN/AN/AN/AN/A
DateClosedEdm.DateTimeOffsettruefalse true N/AN/AN/AN/AN/A
DateExpectedClosingEdm.DateTimeOffsettruefalse false N/AN/AN/AN/AN/A
DateRequestedEdm.DateTimeOffsetfalsefalse true N/AN/AN/AN/AN/A
FileCountEdm.Int32falsefalse true N/AN/AN/AN/AN/A
HasIntegrationActivityEdm.Booleanfalsefalse true N/AN/AN/AN/AN/A
IDEdm.Int32falsefalse false N/AN/AN/AN/AN/A
IsNewEdm.Booleanfalsefalse true N/AN/AN/AN/AN/A
IsOverdueEdm.Booleanfalsefalse true N/AN/AN/AN/AN/A
IssueCountEdm.Int32falsefalse true N/AN/AN/AN/AN/A
NameEdm.Stringfalsetrue false 500N/AN/AN/AN/A
NoteCountEdm.Int32falsefalse true N/AN/AN/AN/AN/A
PriorityNlyte.Model.Priorityfalsetrue false N/AN/AN/AN/AN/A
PriorityFocusIDNlyte.Model.PriorityFocusfalsefalse true N/AN/AN/AN/AN/A
ProcessIDEdm.Int32truetrue false N/AN/AN/AN/AN/A
ReferenceNumberEdm.Int32falsefalse true N/AN/AN/AN/AN/A
RequestedByAssigneeIDEdm.Int32truetrue false N/AN/AN/AN/AN/A
RequestedByGroupsOfResourceIDEdm.Int32falsefalse true N/AN/AN/AN/AN/A
RequestedForAssigneeIDEdm.Int32truefalse false N/AN/AN/AN/AN/A
RequestedForGroupsOfResourceIDEdm.Int32truefalse true N/AN/AN/AN/AN/A
RequestReasonEdm.Stringtruefalse false 1000N/AN/AN/AN/A
ServiceRequestStatusIDNlyte.Model.ServiceRequestStatusfalsefalse true N/AN/AN/AN/AN/A
SLAExpiredEdm.Booleanfalsefalse true N/AN/AN/AN/AN/A
TechnicalLiaisonAssigneeIDEdm.Int32truefalse false N/AN/AN/AN/AN/A
TechnicalLiaisonGroupsOfResourceIDEdm.Int32truefalse true N/AN/AN/AN/AN/A
UntrustedLocationGroupIdEdm.Int32truefalse false N/AN/AN/AN/AN/A
VersionEdm.Int32falsefalse true N/AN/AN/AN/AN/A
ViewedEdm.Booleanfalsefalse false N/AN/AN/AN/AN/A
WorkflowIDEdm.Guidtruefalse true N/AN/AN/AN/AN/A

ServiceRequest Navigational Properties

PropertyType
AssigneesCollection(Nlyte.Model.Assignee)
ChargeToAssigneeNlyte.Model.Assignee
ControlValuesCollection(Nlyte.Model.FormInstanceControlValue)
FilesCollection(Nlyte.Model.ServiceRequestFile)
NotesCollection(Nlyte.Model.ServiceRequestNote)
ProcessNlyte.Model.Process
RequestedByAssigneeNlyte.Model.Assignee
RequestedForAssigneeNlyte.Model.Assignee
TaskInstancesCollection(Nlyte.Model.TaskInstance)
TechnicalLiaisonAssigneeNlyte.Model.Assignee
UntrustedLocationGroupNlyte.Model.LocationGroup



ServiceRequestFile Entity : File

Verb(s)Required Permission(s)LinkDescription
GetWS-ReadFile
DeleteWS-ModifyFile

Key(s)
Name

ServiceRequestFile Structural Properties

No structural properties

ServiceRequestFile Navigational Properties

No navigational properties


ServiceRequestNote Entity : Note

Verb(s)Required Permission(s)LinkDescription
PostWS-AddNote
PatchWS-ModifyNote
DeleteWS-ModifyNote
GetWS-ReadNote

Key(s)
NoteID

ServiceRequestNote Structural Properties

No structural properties

ServiceRequestNote Navigational Properties

No navigational properties


Shelf Entity

Verb(s)Required Permission(s)LinkDescription
GetWS-ReadShelfintegration/api/odata/Shelfs, integration/api/odata/Shelfs({key})
PostWS-AddShelfintegration/api/odata/Shelfs
PatchWS-ModifyShelfintegration/api/odata/Shelfs({key})
PostWithKeyWS-ModifyShelf

Key(s)
ShelfID

Shelf Structural Properties

PropertyTypeNullableMandatoryRead-OnlyString lengthMin ValueMax ValuePrecisionMax Dec PlacesIs Only DateDescription
CabinetAssetIDEdm.Int32falsetrue false N/AN/AN/AN/AN/A
CabinetUNumberEdm.Int32truefalse true N/AN/AN/AN/AN/AThe U on which the shelf is mounted
DepthEdm.Doublefalsefalse true N/AN/AN/AN/AN/A
HeightEdm.Doublefalsefalse true N/AN/AN/AN/AN/A
LowerCabinetUEdm.Int32truefalse false N/AN/AN/AN/AN/AThe bottom U position in which the asset is mounted.
ShelfIDEdm.Int32falsefalse true N/AN/AN/AN/AN/A
ShelfNameEdm.Stringtruefalse false 100N/AN/AN/AN/A
UDisplayLabelEdm.Int32truefalse false N/AN/AN/AN/AN/AThe U label to be displayed, representing the top or the bottom U position, depending on the admin parameter
UMountingIDEdm.Int32truefalse true N/AN/AN/AN/AN/AThe foreign key identifying the entity providing details about the Cabinet U in which an asset is mounted.
WeightLimitEdm.Doublefalsetrue false N/AN/AN/AN/AN/A
WidthEdm.Doublefalsefalse true N/AN/AN/AN/AN/A
XcoordEdm.Doublefalsefalse true N/AN/AN/AN/AN/A
YcoordEdm.Doublefalsefalse true N/AN/AN/AN/AN/A
YOffsetEdm.Doubletruefalse false N/AN/AN/AN/AN/A
ZcoordEdm.Doublefalsefalse true N/AN/AN/AN/AN/A

Shelf Navigational Properties

PropertyType
CabinetNlyte.Model.Cabinet
UMountingNlyte.Model.UMounting



Software Entity - Entity providing details about a software

Verb(s)Required Permission(s)LinkDescription
GetWS-ReadSoftwareintegration/api/odata/Softwares, integration/api/odata/Softwares({key})
PostWS-AddSoftwareintegration/api/odata/Softwares
PostWithKeyWS-ModifySoftware
PatchWS-ModifySoftwareintegration/api/odata/Softwares({key})
DeleteWS-ModifySoftwareintegration/api/odata/Softwares({key})

Key(s)
SoftwareID

Software Structural Properties

PropertyTypeNullableMandatoryRead-OnlyString lengthMin ValueMax ValuePrecisionMax Dec PlacesIs Only DateDescription
IsManagementSoftwareEdm.Booleanfalsefalse false N/AN/AN/AN/AN/A
IsOperatingSystemEdm.Booleanfalsefalse false N/AN/AN/AN/AN/A
IsWebApplicationEdm.Booleanfalsefalse false N/AN/AN/AN/AN/A
RecordStatusNlyte.Model.SoftwareRecordStatusfalsetrue false N/AN/AN/AN/AN/A
SoftwareIDEdm.Int32falsefalse true N/AN/AN/AN/AN/A
SoftwareManufacturerIDEdm.Int32truetrue false N/AN/AN/AN/AN/AThe manufacturer ID, used from the predefined list of manufacturers.
SoftwareNameEdm.Stringfalsetrue false 100N/AN/AN/AN/ASoftware Name. This needs to be Unique in the system.
SoftwareNumberEdm.Int32falsefalse true N/AN/AN/AN/AN/A
SoftwareTypeIDEdm.Int32truefalse false N/AN/AN/AN/AN/A
VersionEdm.Stringtruefalse false 30N/AN/AN/AN/A

Software Navigational Properties

PropertyType
FilesCollection(Nlyte.Model.SoftwareFile)
LinkedServerHostsCollection(Nlyte.Model.ServerHostSoftwareMap)
ServerHostsCollection(Nlyte.Model.ServerHost)
SoftwareManufacturerNlyte.Model.SoftwareManufacturer
SoftwareTypeNlyte.Model.SoftwareType



SoftwareFile Entity : File

Verb(s)Required Permission(s)LinkDescription
GetWS-ReadFile
DeleteWS-ModifyFile

Key(s)
Name

SoftwareFile Structural Properties

No structural properties

SoftwareFile Navigational Properties

No navigational properties


SoftwareManufacturer Entity

Verb(s)Required Permission(s)LinkDescription

Key(s)
SoftwareManufacturerID

SoftwareManufacturer Structural Properties

PropertyTypeNullableMandatoryRead-OnlyString lengthMin ValueMax ValuePrecisionMax Dec PlacesIs Only DateDescription
DetailEdm.Stringfalsetrue false 30N/AN/AN/AN/A
SoftwareManufacturerIDEdm.Int32falsefalse false N/AN/AN/AN/AN/A

SoftwareManufacturer Navigational Properties

No navigational properties


SoftwareType Entity

Verb(s)Required Permission(s)LinkDescription

Key(s)
SoftwareTypeID

SoftwareType Structural Properties

PropertyTypeNullableMandatoryRead-OnlyString lengthMin ValueMax ValuePrecisionMax Dec PlacesIs Only DateDescription
DetailEdm.Stringfalsetrue false 30N/AN/AN/AN/ASoftware type
SoftwareTypeIDEdm.Int32falsefalse false N/AN/AN/AN/AN/A

SoftwareType Navigational Properties

No navigational properties


SqlView Entity

Verb(s)Required Permission(s)LinkDescription

Key(s)
Name

SqlView Structural Properties

PropertyTypeNullableMandatoryRead-OnlyString lengthMin ValueMax ValuePrecisionMax Dec PlacesIs Only DateDescription
NameEdm.Stringfalsefalse false N/AN/AN/AN/AN/A

SqlView Navigational Properties

No navigational properties


SqlViewValue Entity

Verb(s)Required Permission(s)LinkDescription

Key(s)
ID

SqlViewValue Structural Properties

PropertyTypeNullableMandatoryRead-OnlyString lengthMin ValueMax ValuePrecisionMax Dec PlacesIs Only DateDescription
IDEdm.Int32falsefalse false N/AN/AN/AN/AN/A
NameEdm.Stringtruefalse false N/AN/AN/AN/AN/A

SqlViewValue Navigational Properties

No navigational properties


StandardGeneratorAuxiliaryMaterial Entity : AuxiliaryMaterial

Verb(s)Required Permission(s)LinkDescription
GetWS-ReadAuxiliaryMaterialintegration/api/odata/StandardGeneratorAuxiliaryMaterials, integration/api/odata/StandardGeneratorAuxiliaryMaterials({key})
PostWS-AddAuxiliaryMaterialintegration/api/odata/StandardGeneratorAuxiliaryMaterials
PostWithKeyWS-ModifyAuxiliaryMaterial
PatchWS-ModifyAuxiliaryMaterialintegration/api/odata/StandardGeneratorAuxiliaryMaterials({key})
DeleteWS-ModifyAuxiliaryMaterialintegration/api/odata/StandardGeneratorAuxiliaryMaterials({key})

Key(s)
MaterialID

StandardGeneratorAuxiliaryMaterial Structural Properties

No structural properties

StandardGeneratorAuxiliaryMaterial Navigational Properties

No navigational properties


StandardNetworkMaterial Entity : NetworkMaterial

Verb(s)Required Permission(s)LinkDescription
GetWS-ReadNetworkMaterialintegration/api/odata/StandardNetworkMaterials, integration/api/odata/StandardNetworkMaterials({key})
PostWS-AddNetworkMaterialintegration/api/odata/StandardNetworkMaterials
PostWithKeyWS-ModifyNetworkMaterialintegration/api/odata/StandardNetworkMaterials({key})
PatchWS-ModifyNetworkMaterialintegration/api/odata/StandardNetworkMaterials({key})
DeleteWS-ModifyNetworkMaterialintegration/api/odata/StandardNetworkMaterials({key})

Key(s)
MaterialID

StandardNetworkMaterial Structural Properties

PropertyTypeNullableMandatoryRead-OnlyString lengthMin ValueMax ValuePrecisionMax Dec PlacesIs Only DateDescription
AirflowTypeIDNlyte.Model.AirflowTypeEnumfalsetrue false N/AN/AN/AN/AN/ASelected air flow, from the available values defined in the administration area
CalculatedMpafPowerConsumptionEdm.Decimaltruefalse true N/AN/AN/AN/AN/ARead-only property, value provided by the service based on the PublishedPowerConsumption and the MpafOverride
ConsumerPowerFactorEdm.Decimalfalsefalse true N/AN/AN/AN/AN/A
MaterialCategoryIDEdm.Int32truefalse false N/AN/AN/AN/AN/A
MpafOverrideEdm.Decimaltruefalse false N/A0.00199963Value inserted by the user, while the material is in Planned status
PowerTypeIDNlyte.Model.PowerTypeEnumfalsetrue false N/AN/AN/AN/AN/APower type: phased or direct current
PublishedPowerConsumptionEdm.Decimaltruetrue false N/A0.00199963Value inserted by the user, while the material is in Planned status
RequiredPlugsEdm.Int32falsetrue false N/AN/AN/AN/AN/AValue inserted by the user, while the material is in Planned status
RequiresDiversePowerEdm.Booleanfalsefalse false N/AN/AN/AN/AN/AValue available to be updated by the user only if RequiredPlugs TotalPlugs
WorkableFootPrintFrontEdm.Doublefalsefalse false N/A0999999999999.9999164
WorkableFootPrintHeightEdm.Doublefalsefalse false N/A0999999999999.9999164
WorkableFootPrintRearEdm.Doublefalsefalse false N/A0999999999999.9999164

StandardNetworkMaterial Navigational Properties

PropertyType
InputConnectorMaterialsCollection(Nlyte.Model.InputConnectorMaterial)



StandardPDUMaterial Entity : PDUMaterial

Verb(s)Required Permission(s)LinkDescription
GetWS-ReadPDUMaterialintegration/api/odata/StandardPDUMaterials, integration/api/odata/StandardPDUMaterials({key})
PostWS-AddPDUMaterialintegration/api/odata/StandardPDUMaterials
PostWithKeyWS-ModifyPDUMaterial
PatchWS-ModifyPDUMaterialintegration/api/odata/StandardPDUMaterials({key})
DeleteWS-ModifyPDUMaterialintegration/api/odata/StandardPDUMaterials({key})

Key(s)
MaterialID

StandardPDUMaterial Structural Properties

No structural properties

StandardPDUMaterial Navigational Properties

No navigational properties


StandardServerMaterial Entity : ServerMaterial - Material type inheriting properties from the base type

Verb(s)Required Permission(s)LinkDescription
GetWS-ReadServerMaterialintegration/api/odata/StandardServerMaterials, integration/api/odata/StandardServerMaterials({key})
PostWS-AddServerMaterialintegration/api/odata/StandardServerMaterials
PostWithKeyWS-ModifyServerMaterialintegration/api/odata/StandardServerMaterials({key})
PatchWS-ModifyServerMaterialintegration/api/odata/StandardServerMaterials({key})
DeleteWS-ModifyServerMaterialintegration/api/odata/StandardServerMaterials({key})

Key(s)
MaterialID

StandardServerMaterial Structural Properties

PropertyTypeNullableMandatoryRead-OnlyString lengthMin ValueMax ValuePrecisionMax Dec PlacesIs Only DateDescription
AirflowTypeIDNlyte.Model.AirflowTypeEnumtruefalse false N/AN/AN/AN/AN/ASelected air flow, from the available values defined in the administration area
MaterialCategoryIDEdm.Int32truefalse false N/AN/AN/AN/AN/A
PlugTypeEdm.Stringtruefalse false 50N/AN/AN/AN/AProperty selected from the available types, available as lookups InputConnectorTypes
PowerTypeIDNlyte.Model.PowerTypeEnumtruefalse false N/AN/AN/AN/AN/APower type: phased or direct current
PublishedPowerConsumptionEdm.Decimalfalsefalse false N/A0.00199963
RequiredPlugsEdm.Int32falsetrue false N/AN/AN/AN/AN/AValue inserted by the user, while the material is in Planned status
RequiresDiversePowerEdm.Booleanfalsefalse false N/AN/AN/AN/AN/AValue available to be updated by the user only if RequiredPlugs TotalPlugs
RequiresKVMSwitchEdm.Booleantruefalse false N/AN/AN/AN/AN/A
TotalPlugsEdm.Int32falsetrue false N/AN/AN/AN/AN/AValue inserted by the user, while the material is in Planned status
WorkableFootPrintFrontEdm.Doublefalsefalse false N/A0999999999999.9999164
WorkableFootPrintHeightEdm.Doublefalsefalse false N/A0999999999999.9999164
WorkableFootPrintRearEdm.Doublefalsefalse false N/A0999999999999.9999164

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)LinkDescription
GetWS-ReadStaticSwitchintegration/api/odata/StaticSwitches, integration/api/odata/StaticSwitches({key})
PatchWS-ModifyStaticSwitchintegration/api/odata/StaticSwitches({key})
PostWithKeyWS-ModifyStaticSwitchintegration/api/odata/StaticSwitches({key})
DeleteWS-ModifyStaticSwitchintegration/api/odata/StaticSwitches({key})
PostWS-AddStaticSwitchintegration/api/odata/StaticSwitches

Key(s)
AssetID

StaticSwitch Structural Properties

PropertyTypeNullableMandatoryRead-OnlyString lengthMin ValueMax ValuePrecisionMax Dec PlacesIs Only DateDescription
AuditDateEdm.DateTimeOffsettruefalse false N/AN/AN/AN/AN/A
AuditStatusCorrectEdm.Booleantruefalse false N/AN/AN/AN/AN/A
CurrentPowerFactorEdm.Decimaltruefalse true N/AN/AN/AN/AN/ARead-only property representing the percentage of power drawn by a PDD asset that is available to its consumers
IsMasterRedundancyDeviceEdm.Booleanfalsefalse false N/AN/AN/AN/AN/AValue inserted by the user
LastAuditorAccountIDEdm.Int32truefalse false N/AN/AN/AN/AN/A
OutputCountEdm.Int32falsefalse true N/AN/AN/AN/AN/A
PowerFactorOverrideEdm.Decimaltruefalse false N/A0132Value provided by the user, overriding the CurrentPowerFactor value
RealtimePowerFactorEdm.Decimaltruefalse true N/AN/AN/AN/AN/ARead-only value.
TotalPlugsEdm.Int32falsefalse true N/AN/AN/AN/AN/A

StaticSwitch Navigational Properties

PropertyType
InputConnectorsCollection(Nlyte.Model.InputConnector)
OutputConnectorsCollection(Nlyte.Model.OutputConnector)
StaticSwitchMaterialNlyte.Model.StaticSwitchMaterial
UtilitiesCollection(Nlyte.Model.Supplier)
WiresCollection(Nlyte.Model.Wire)



StaticSwitchMaterial Entity : Material - Material type inheriting properties from the base type

Verb(s)Required Permission(s)LinkDescription
GetWS-ReadStaticSwitchMaterialintegration/api/odata/StaticSwitchMaterials, integration/api/odata/StaticSwitchMaterials({key})
PostWS-AddStaticSwitchMaterialintegration/api/odata/StaticSwitchMaterials
PostWithKeyWS-ModifyStaticSwitchMaterialintegration/api/odata/StaticSwitchMaterials({key})
PatchWS-ModifyStaticSwitchMaterialintegration/api/odata/StaticSwitchMaterials({key})
DeleteWS-ModifyStaticSwitchMaterialintegration/api/odata/StaticSwitchMaterials({key})

Key(s)
MaterialID

StaticSwitchMaterial Structural Properties

PropertyTypeNullableMandatoryRead-OnlyString lengthMin ValueMax ValuePrecisionMax Dec PlacesIs Only DateDescription
CalculatedMaxKWEdm.Decimaltruefalse true N/AN/AN/AN/AN/A
DistributorPowerFactorEdm.Decimalfalsefalse true N/AN/AN/AN/AN/A
InputPowerTypeIDNlyte.Model.PowerTypeEnumfalsetrue false N/AN/AN/AN/AN/APower type: phased or direct current
MaterialCategoryIDEdm.Int32truefalse false N/AN/AN/AN/AN/A
MaxAmperageEdm.Decimaltruefalse false N/A099999.99983
MaxVoltageEdm.Decimaltruefalse false N/A099999.99983
TotalOutletsEdm.Int32falsetrue false N/AN/AN/AN/AN/A
TotalPlugsEdm.Int32falsefalse true N/AN/AN/AN/AN/AValue inserted by the user, while the material is in Planned status
UHeightEdm.Int64falsefalse true N/AN/AN/AN/AN/A
WorkableFootPrintFrontEdm.Doublefalsefalse false N/A0999999999999.9999164
WorkableFootPrintHeightEdm.Doublefalsefalse false N/A0999999999999.9999164
WorkableFootPrintRearEdm.Doublefalsefalse false N/A0999999999999.9999164

StaticSwitchMaterial Navigational Properties

PropertyType
InputConnectorMaterialsCollection(Nlyte.Model.InputConnectorMaterial)
OutputConnectorMaterialsCollection(Nlyte.Model.OutputConnectorMaterial)



StoragePeripheralMaterial Entity : PeripheralMaterial

Verb(s)Required Permission(s)LinkDescription
GetWS-ReadPeripheralMaterialintegration/api/odata/StoragePeripheralMaterials, integration/api/odata/StoragePeripheralMaterials({key})
PostWS-AddPeripheralMaterialintegration/api/odata/StoragePeripheralMaterials
PostWithKeyWS-ModifyPeripheralMaterialintegration/api/odata/StoragePeripheralMaterials({key})
PatchWS-ModifyPeripheralMaterialintegration/api/odata/StoragePeripheralMaterials({key})
DeleteWS-ModifyPeripheralMaterialintegration/api/odata/StoragePeripheralMaterials({key})

Key(s)
MaterialID

StoragePeripheralMaterial Structural Properties

PropertyTypeNullableMandatoryRead-OnlyString lengthMin ValueMax ValuePrecisionMax Dec PlacesIs Only DateDescription
AirflowTypeIDNlyte.Model.AirflowTypeEnumtruetrue false N/AN/AN/AN/AN/ASelected air flow, from the available values defined in the administration area
CalculatedMpafPowerConsumptionEdm.Decimaltruefalse true N/AN/AN/AN/AN/A
ConsumerPowerFactorEdm.Decimalfalsefalse true N/AN/AN/AN/AN/A
MpafOverrideEdm.Decimaltruefalse false N/A0.00199963Value inserted by the user, while the material is in Planned status
PowerTypeIDNlyte.Model.PowerTypeEnumtruetrue false N/AN/AN/AN/AN/APower type: phased or direct current
PublishedPowerConsumptionEdm.Decimaltruefalse false N/A0.00199963Value inserted by the user, while the material is in Planned status
RequiredPlugsEdm.Int32truetrue false N/AN/AN/AN/AN/AValue inserted by the user, while the material is in Planned status
RequiresDiversePowerEdm.Booleantruefalse false N/AN/AN/AN/AN/A
TotalPlugsEdm.Int32truetrue false N/AN/AN/AN/AN/AValue inserted by the user, while the material is in Planned status
WorkableFootPrintFrontEdm.Doublefalsefalse false N/A0999999999999.9999164
WorkableFootPrintHeightEdm.Doublefalsefalse false N/A0999999999999.9999164
WorkableFootPrintRearEdm.Doublefalsefalse false N/A0999999999999.9999164

StoragePeripheralMaterial Navigational Properties

PropertyType
InputConnectorMaterialsCollection(Nlyte.Model.InputConnectorMaterial)
MountingTypeNlyte.Model.MountingType



StorageUsage Entity

Verb(s)Required Permission(s)LinkDescription

Key(s)
StorageUsageID

StorageUsage Structural Properties

PropertyTypeNullableMandatoryRead-OnlyString lengthMin ValueMax ValuePrecisionMax Dec PlacesIs Only DateDescription
DetailEdm.Stringfalsetrue false 30N/AN/AN/AN/AStorage Usage
StorageUsageIDEdm.Int32falsefalse false N/AN/AN/AN/AN/A

StorageUsage Navigational Properties

No navigational properties


Subnet Entity

Verb(s)Required Permission(s)LinkDescription
GetWS-ReadCabinetSubnetMapintegration/api/odata/Subnets, integration/api/odata/Subnets({key})
PostWS-AddCabinetSubnetMapintegration/api/odata/Subnets
PatchWS-ModifyCabinetSubnetMapintegration/api/odata/Subnets({key})
PostWithKeyWS-ModifyCabinetSubnetMap
DeleteWS-ModifyCabinetSubnetMapintegration/api/odata/Subnets({key})

Key(s)
SubnetID

Subnet Structural Properties

PropertyTypeNullableMandatoryRead-OnlyString lengthMin ValueMax ValuePrecisionMax Dec PlacesIs Only DateDescription
CIDREdm.Bytefalsefalse false N/AN/AN/AN/AN/A
FirstOctetAEdm.Bytefalsefalse false N/AN/AN/AN/AN/A
FirstOctetBEdm.Bytefalsefalse false N/AN/AN/AN/AN/A
FirstOctetCEdm.Bytefalsefalse false N/AN/AN/AN/AN/A
FirstOctetDEdm.Bytefalsefalse false N/AN/AN/AN/AN/A
LastOctetAEdm.Bytefalsefalse false N/AN/AN/AN/AN/A
LastOctetBEdm.Bytefalsefalse false N/AN/AN/AN/AN/A
LastOctetCEdm.Bytefalsefalse false N/AN/AN/AN/AN/A
LastOctetDEdm.Bytefalsefalse false N/AN/AN/AN/AN/A
OctetAEdm.Bytefalsefalse false N/AN/AN/AN/AN/A
OctetBEdm.Bytefalsefalse false N/AN/AN/AN/AN/A
OctetCEdm.Bytefalsefalse false N/AN/AN/AN/AN/A
OctetDEdm.Bytefalsefalse false N/AN/AN/AN/AN/A
SubnetIDEdm.Int32falsefalse true N/AN/AN/AN/AN/A

Subnet Navigational Properties

PropertyType
CabinetsCollection(Nlyte.Model.Cabinet)



SubnetLocationGroupMap Entity - ToDo

Verb(s)Required Permission(s)LinkDescription
GetWS-ReadSubnetLocationGroupMapintegration/api/odata/SubnetLocationGroupMaps, integration/api/odata/SubnetLocationGroupMaps({key})
PostWS-AddSubnetLocationGroupMapintegration/api/odata/SubnetLocationGroupMaps
PostWithKeyWS-ModifySubnetLocationGroupMap
PatchWS-ModifySubnetLocationGroupMapintegration/api/odata/SubnetLocationGroupMaps({key})
DeleteWS-ModifySubnetLocationGroupMapintegration/api/odata/SubnetLocationGroupMaps({key})

Key(s)
LocationGroupSubnetMapID

SubnetLocationGroupMap Structural Properties

PropertyTypeNullableMandatoryRead-OnlyString lengthMin ValueMax ValuePrecisionMax Dec PlacesIs Only DateDescription
LocationGroupIDEdm.Int32truefalse false N/AN/AN/AN/AN/AForeign key identifying the location
LocationGroupSubnetMapIDEdm.Int32falsefalse true N/AN/AN/AN/AN/A
SubnetIDEdm.Int32truefalse false N/AN/AN/AN/AN/A

SubnetLocationGroupMap Navigational Properties

PropertyType
LocationGroupNlyte.Model.LocationGroup
SubnetNlyte.Model.Subnet



SubStatus Entity

Verb(s)Required Permission(s)LinkDescription

Key(s)
SubStatusID

SubStatus Structural Properties

PropertyTypeNullableMandatoryRead-OnlyString lengthMin ValueMax ValuePrecisionMax Dec PlacesIs Only DateDescription
ActiveEdm.Booleanfalsefalse false N/AN/AN/AN/AN/A
NameEdm.Stringfalsetrue false 25N/AN/AN/AN/A
SubStatusIDEdm.Int32falsefalse false N/AN/AN/AN/AN/A

SubStatus Navigational Properties

No navigational properties


Supplier Entity - Entity providing power supplier details for asset entities

Verb(s)Required Permission(s)LinkDescription
GetWS-ReadUtilityintegration/api/odata/Utilities, integration/api/odata/Utilities({key})
PatchWS-ModifyUtility
DeleteWS-ModifyUtility
PostWithKeyWS-ModifyUtility
PostWS-AddUtility

Key(s)
SupplierID

Supplier Structural Properties

PropertyTypeNullableMandatoryRead-OnlyString lengthMin ValueMax ValuePrecisionMax Dec PlacesIs Only DateDescription
AssetIDEdm.Int32truefalse false N/AN/AN/AN/AN/AId of the asset acting as power distributor
CommercialSupplyVoltageEdm.Int32true false
CostPerUnitDayEdm.Decimaltruefalse false N/A0999999.9982
CostPerUnitNightEdm.Decimaltruefalse false N/A0999999.9982
FixedCostEdm.Decimaltruefalse false N/A0999999.9982
LocationGroupIDEdm.Int32falsefalse true N/AN/AN/AN/AN/A
MaxKVAEdm.Decimaltruefalse false N/A099999999.9999124
MPANEdm.Stringtruefalse false 50N/AN/AN/AN/A
NameEdm.Stringtruefalse false 50N/AN/AN/AN/A
PowerTypeIDNlyte.Model.PowerTypeEnumfalsefalse false N/AN/AN/AN/AN/APower type: phased or direct current
SupplierIDEdm.Int32falsefalse false N/AN/AN/AN/AN/A
SupplierTypeIDNlyte.Model.SupplierTypeEnumfalsefalse true N/AN/AN/AN/AN/A

Supplier Navigational Properties

PropertyType
DistributorNlyte.Model.Asset
WiresCollection(Nlyte.Model.SupplierWire)



SupplierMaterial Entity - Entity providing power supplier details for material entities

Verb(s)Required Permission(s)LinkDescription

Key(s)
SupplierMaterialID

SupplierMaterial Structural Properties

PropertyTypeNullableMandatoryRead-OnlyString lengthMin ValueMax ValuePrecisionMax Dec PlacesIs Only DateDescription
AvailableKVAhEdm.Decimaltruefalse false N/AN/AN/AN/AN/A
CostPerUnitEdm.Decimaltruefalse false N/AN/AN/AN/AN/A
FixedCostEdm.Decimaltruefalse false N/AN/AN/AN/AN/A
MaterialIDEdm.Int32truefalse false N/AN/AN/AN/AN/A
MaxKVAEdm.Decimalfalsefalse false N/AN/AN/AN/AN/A
NameEdm.Stringfalsetrue false 50N/AN/AN/AN/A
PowerTypeIDNlyte.Model.PowerTypeEnumfalsefalse false N/AN/AN/AN/AN/APower type: phased or direct current
SupplierMaterialIDEdm.Int32falsefalse false N/AN/AN/AN/AN/A
SupplierTypeIDNlyte.Model.SupplierTypeEnumfalsefalse false N/AN/AN/AN/AN/A

SupplierMaterial Navigational Properties

PropertyType
DistributorMaterialNlyte.Model.DistributorMaterial



SupplierMaterialWire Entity

Verb(s)Required Permission(s)LinkDescription

Key(s)
SupplierMaterialWireID

SupplierMaterialWire Structural Properties

PropertyTypeNullableMandatoryRead-OnlyString lengthMin ValueMax ValuePrecisionMax Dec PlacesIs Only DateDescription
PhaseEdm.Int32falsefalse false N/AN/AN/AN/AN/A
PositionEdm.Int32falsefalse false N/AN/AN/AN/AN/A
SupplierMaterialIDEdm.Int32truefalse false N/AN/AN/AN/AN/A
SupplierMaterialWireIDEdm.Int32falsefalse false N/AN/AN/AN/AN/A

SupplierMaterialWire Navigational Properties

PropertyType
SupplierMaterialNlyte.Model.SupplierMaterial



SupplierWire Entity

Verb(s)Required Permission(s)LinkDescription
GetWS-ReadUtility
PatchWS-ModifyUtility
DeleteWS-ModifyUtility
PostWithKeyWS-ModifyUtility
PostWS-ModifyUtility

Key(s)
SupplierWireID

SupplierWire Structural Properties

PropertyTypeNullableMandatoryRead-OnlyString lengthMin ValueMax ValuePrecisionMax Dec PlacesIs Only DateDescription
PhaseEdm.Int32falsefalse false N/AN/AN/AN/AN/A
PositionEdm.Int32falsefalse false N/AN/AN/AN/AN/A
SupplierIDEdm.Int32truefalse false N/AN/AN/AN/AN/A
SupplierWireIDEdm.Int32falsefalse false N/AN/AN/AN/AN/A

SupplierWire Navigational Properties

PropertyType
SupplierNlyte.Model.Supplier



SupportGroup Entity - Entity representing a group of type support

Verb(s)Required Permission(s)LinkDescription
GetWS-ReadSupportGroupintegration/api/odata/SupportGroups, integration/api/odata/SupportGroups({key})
PatchWS-ModifySupportGroupintegration/api/odata/SupportGroups({key})
DeleteWS-ModifySupportGroupintegration/api/odata/SupportGroups({key})
PostWS-AddSupportGroupintegration/api/odata/SupportGroups
PostWithKeyWS-ModifySupportGroupintegration/api/odata/SupportGroups({key})

Key(s)
SupportGroupID

SupportGroup Structural Properties

PropertyTypeNullableMandatoryRead-OnlyString lengthMin ValueMax ValuePrecisionMax Dec PlacesIs Only DateDescription
AssigneeIDEdm.Int32falsefalse true N/AN/AN/AN/AN/A
DescriptionEdm.Stringtruefalse false 255N/AN/AN/AN/A
EmailAddressEdm.Stringtruefalse false 254N/AN/AN/AN/A
HasChildrenEdm.Booleanfalsefalse true N/AN/AN/AN/AN/AGroup was used as a parent group
ParentSupportGroupIDEdm.Int32falsetrue true N/AN/AN/AN/AN/A
RecordStatusNlyte.Model.OrganisationGroupRecordStatusfalsefalse true N/AN/AN/AN/AN/AReflects the real status of the group as is in the data-center Canceled or Active.
SupportGroupIDEdm.Int32truefalse true N/AN/AN/AN/AN/A
SupportGroupNameEdm.Stringfalsetrue false 255N/AN/AN/AN/A
SupportGroupNumberEdm.Int32truefalse true N/AN/AN/AN/AN/A
TelephoneNumberEdm.Stringtruefalse false 30N/AN/AN/AN/A

SupportGroup Navigational Properties

PropertyType
AssociatedSupportGroupsCollection(Nlyte.Model.SupportGroup)
NotesCollection(Nlyte.Model.SupportGroupNote)
ParentSupportGroupNlyte.Model.SupportGroup
SupportGroupContactsCollection(Nlyte.Model.SupportGroupResourceMap)



SupportGroupAssetMap Entity

Verb(s)Required Permission(s)LinkDescription
GetWS-ReadSupportGroupAssetMap
PatchWS-ModifySupportGroupAssetMap
DeleteWS-ModifySupportGroupAssetMap
PostWS-AddSupportGroupAssetMap
PostWithKeyWS-ModifySupportGroupAssetMap

Key(s)
ID

SupportGroupAssetMap Structural Properties

PropertyTypeNullableMandatoryRead-OnlyString lengthMin ValueMax ValuePrecisionMax Dec PlacesIs Only DateDescription
ColourIndexEdm.Int32truefalse false N/AN/AN/AN/AN/A
CultureIDEdm.Int32truefalse false N/AN/AN/AN/AN/A
DescriptionEdm.Stringtruefalse false 255N/AN/AN/AN/A
EmailAddressEdm.Stringtruefalse false 254N/AN/AN/AN/A
IDEdm.Int32falsefalse false N/AN/AN/AN/AN/A
ParentSupportGroupIDEdm.Int32truefalse false N/AN/AN/AN/AN/A
RecordStatusEdm.Int32falsefalse false N/AN/AN/AN/AN/A
SupportGroupIDEdm.Int32truefalse false N/AN/AN/AN/AN/A
SupportGroupNameEdm.Stringtruefalse false 255N/AN/AN/AN/A
SupportGroupNumberEdm.Int32truefalse false N/AN/AN/AN/AN/A
SupportPercentageEdm.Bytefalsefalse false N/AN/AN/AN/AN/A
TelephoneNumberEdm.Stringtruefalse false 30N/AN/AN/AN/A

SupportGroupAssetMap Navigational Properties

PropertyType
CultureNlyte.Model.Culture
ParentNlyte.Model.SupportGroup
SupportGroupNlyte.Model.SupportGroup



SupportGroupNote Entity : Note

Verb(s)Required Permission(s)LinkDescription
PostWS-AddNote
PatchWS-ModifyNote
DeleteWS-ModifyNote
GetWS-ReadNote

Key(s)
NoteID

SupportGroupNote Structural Properties

No structural properties

SupportGroupNote Navigational Properties

No navigational properties


SupportGroupResourceMap Entity

Verb(s)Required Permission(s)LinkDescription
GetWS-ReadSupportGroupResourceMap
PatchWS-ModifySupportGroupResourceMap
DeleteWS-ModifySupportGroupResourceMap
PostWS-AddSupportGroupResourceMap
PostWithKeyWS-ModifySupportGroupResourceMap

Key(s)
SupportGroupResourceMapID

SupportGroupResourceMap Structural Properties

PropertyTypeNullableMandatoryRead-OnlyString lengthMin ValueMax ValuePrecisionMax Dec PlacesIs Only DateDescription
ClientUserGUIDEdm.Stringtruefalse true 100N/AN/AN/AN/A
CompanyEdm.Stringtruefalse true 50N/AN/AN/AN/A
CompanyPhoneNumberEdm.Stringtruefalse true 50N/AN/AN/AN/A
CultureIDEdm.Int32truefalse true N/AN/AN/AN/AN/A
DepartmentEdm.Stringtruefalse true 50N/AN/AN/AN/A
DepartmentPhoneNumberEdm.Stringtruefalse true 50N/AN/AN/AN/A
EmailEdm.Stringtruefalse true 254N/AN/AN/AN/A
ForenameEdm.Stringtruefalse true 50N/AN/AN/AN/A
ManagerResourceIDEdm.Int32truefalse true N/AN/AN/AN/AN/A
MeasurementSystemIDEdm.Int32truefalse true N/AN/AN/AN/AN/A
MiddlenameEdm.Stringtruefalse true 50N/AN/AN/AN/A
MobileNumberEdm.Stringtruefalse true 50N/AN/AN/AN/A
PhoneNumberEdm.Stringtruefalse true 50N/AN/AN/AN/A
PriorityEdm.Int32falsefalse false N/AN/AN/AN/AN/A
ResourceIDEdm.Int32truefalse false N/AN/AN/AN/AN/A
RFIDCardIDEdm.Stringtruefalse true 50N/AN/AN/AN/A
SupportGroupIDEdm.Int32truefalse false N/AN/AN/AN/AN/A
SupportGroupResourceMapIDEdm.Int32falsefalse false N/AN/AN/AN/AN/A
SurnameEdm.Stringtruefalse true 50N/AN/AN/AN/A
TimeZoneEdm.Doubletruefalse true N/AN/AN/AN/AN/A
TitleEdm.Stringtruefalse true 10N/AN/AN/AN/A

SupportGroupResourceMap Navigational Properties

PropertyType
CultureNlyte.Model.Culture
MeasurementSystemNlyte.Model.MeasurementSystem
ParentNlyte.Model.Resource
ResourceNlyte.Model.Resource
SupportGroupNlyte.Model.SupportGroup



Task Entity

Verb(s)Required Permission(s)LinkDescription

Key(s)
ID

Task Structural Properties

PropertyTypeNullableMandatoryRead-OnlyString lengthMin ValueMax ValuePrecisionMax Dec PlacesIs Only DateDescription
ConfigurationEdm.Stringtruefalse false N/AN/AN/AN/AN/A
DisplayOrderEdm.Int32falsefalse false N/AN/AN/AN/AN/A
DurationInMinsEdm.Int64falsefalse false N/AN/AN/AN/AN/A
IDEdm.Int32falsefalse false N/AN/AN/AN/AN/A
InstructionsEdm.Stringtruefalse false 1000N/AN/AN/AN/A
ItemProcessDescriptionEdm.Stringtruefalse false 100N/AN/AN/AN/A
NameEdm.Stringfalsetrue false 250N/AN/AN/AN/A
OnErrorActionEdm.Int32truefalse false N/AN/AN/AN/AN/A
ParentTaskContainerIDEdm.Int32truetrue false N/AN/AN/AN/AN/A
PerformerAssigneeIDEdm.Int32truefalse false N/AN/AN/AN/AN/A
ProcessIDEdm.Int32truefalse true N/AN/AN/AN/AN/A
SequenceNumberEdm.Int32falsetrue false N/AN/AN/AN/AN/A
SLANotificationExpiryTimespanEdm.Int64truefalse false N/AN/AN/AN/AN/A
SLATimespanEdm.Int64truefalse false N/AN/AN/AN/AN/A
TypeNlyte.Model.TaskTypefalse false

Task Navigational Properties

PropertyType
AssigneeNlyte.Model.Assignee
AssigneesCollection(Nlyte.Model.Assignee)
ProcessNlyte.Model.Process
TaskContainerNlyte.Model.TaskContainer
TaskFormControlsCollection(Nlyte.Model.TaskFormControl)
TaskFormsCollection(Nlyte.Model.TaskForm)
TaskIntegrationAttributesCollection(Nlyte.Model.TaskIntegrationAttributes)



TaskContainer Entity

Verb(s)Required Permission(s)LinkDescription

Key(s)
ID

TaskContainer Structural Properties

PropertyTypeNullableMandatoryRead-OnlyString lengthMin ValueMax ValuePrecisionMax Dec PlacesIs Only DateDescription
DisplayOrderEdm.Int32falsefalse false N/AN/AN/AN/AN/A
IDEdm.Int32falsefalse false N/AN/AN/AN/AN/A
IsDefaultEdm.Booleantruefalse false N/AN/AN/AN/AN/A
MaximumLoopsEdm.Int32truefalse false N/AN/AN/AN/AN/A
NameEdm.Stringtrue false
ParentTaskContainerIDEdm.Int32truefalse false N/AN/AN/AN/AN/A
ProcessIDEdm.Int32truefalse true N/AN/AN/AN/AN/A
RuleEdm.Stringtruefalse false 2147483647N/AN/AN/AN/A
TypeNlyte.Model.TaskContainerTypefalse false

TaskContainer Navigational Properties

PropertyType
ParentNlyte.Model.TaskContainer
ProcessNlyte.Model.Process



TaskForm Entity

Verb(s)Required Permission(s)LinkDescription

Key(s)
ID

TaskForm Structural Properties

PropertyTypeNullableMandatoryRead-OnlyString lengthMin ValueMax ValuePrecisionMax Dec PlacesIs Only DateDescription
FormIDEdm.Int32truefalse false N/AN/AN/AN/AN/A
FormOrderEdm.Int32falsefalse true N/AN/AN/AN/AN/A
IDEdm.Int32falsefalse true N/AN/AN/AN/AN/A
TaskIDEdm.Int32truefalse true N/AN/AN/AN/AN/A

TaskForm Navigational Properties

PropertyType
FormNlyte.Model.Form
TaskNlyte.Model.Task



TaskFormControl Entity

Verb(s)Required Permission(s)LinkDescription

Key(s)
ID

TaskFormControl Structural Properties

PropertyTypeNullableMandatoryRead-OnlyString lengthMin ValueMax ValuePrecisionMax Dec PlacesIs Only DateDescription
FormControlIDEdm.Int32truefalse false N/AN/AN/AN/AN/A
IDEdm.Int32falsefalse true N/AN/AN/AN/AN/A
IsEditableEdm.Booleanfalsefalse false N/AN/AN/AN/AN/A
IsVisibleEdm.Booleanfalsefalse false N/AN/AN/AN/AN/A
TaskIDEdm.Int32truefalse true N/AN/AN/AN/AN/A

TaskFormControl Navigational Properties

PropertyType
FormControlNlyte.Model.FormControl
TaskNlyte.Model.Task



TaskInstance Entity

Verb(s)Required Permission(s)LinkDescription
GetWS-ReadTaskintegration/api/odata/TaskInstances, integration/api/odata/TaskInstances({key})
PatchWS-ModifyTaskintegration/api/odata/TaskInstances({key})
PutWS-ModifyTaskintegration/api/odata/TaskInstances({key})

Key(s)
ID

TaskInstance Structural Properties

PropertyTypeNullableMandatoryRead-OnlyString lengthMin ValueMax ValuePrecisionMax Dec PlacesIs Only DateDescription
AgingInMinsEdm.Int64falsefalse true N/AN/AN/AN/AN/A
DateAgingLastUpdatedEdm.DateTimeOffsettruefalse true N/AN/AN/AN/AN/A
DateCreatedEdm.DateTimeOffsetfalsefalse true N/AN/AN/AN/AN/A
DateExpectedClosingEdm.DateTimeOffsettruefalse true N/AN/AN/AN/AN/A
DateLastClosedEdm.DateTimeOffsettruefalse true N/AN/AN/AN/AN/A
DateLastStatusChangedEdm.DateTimeOffsetfalsefalse true N/AN/AN/AN/AN/A
DateStartedEdm.DateTimeOffsettruefalse true N/AN/AN/AN/AN/A
FileCountEdm.Int32falsefalse true N/AN/AN/AN/AN/A
HasIntegrationActivityEdm.Booleanfalsefalse true N/AN/AN/AN/AN/A
IDEdm.Int32falsefalse true N/AN/AN/AN/AN/A
IsNewEdm.Booleanfalsefalse true N/AN/AN/AN/AN/A
IsOverdueEdm.Booleanfalsefalse true N/AN/AN/AN/AN/A
IssueCountEdm.Int32falsefalse true N/AN/AN/AN/AN/A
LastDateUpdatedEdm.DateTimeOffsetfalsefalse true N/AN/AN/AN/AN/A
NoteCountEdm.Int32falsefalse true N/AN/AN/AN/AN/A
OpenedCountEdm.Int32truefalse true N/AN/AN/AN/AN/A
OwnerAssigneeIDEdm.Int32truetrue false N/AN/AN/AN/AN/A
OwnerGroupsOfResourceIDEdm.Int32falsefalse true N/AN/AN/AN/AN/A
PriorityNlyte.Model.Prioritytruefalse false N/AN/AN/AN/AN/A
PriorityFocusIDNlyte.Model.PriorityFocusfalsefalse true N/AN/AN/AN/AN/A
ServiceRequestIDEdm.Int32truefalse true N/AN/AN/AN/AN/A
SLANotifiedEdm.Int32falsefalse true N/AN/AN/AN/AN/A
SRViewerVisibleEdm.Booleantruefalse true N/AN/AN/AN/AN/A
StatusNlyte.Model.TaskInstanceStatustruefalse false N/AN/AN/AN/AN/A
TaskIDEdm.Int32truefalse true N/AN/AN/AN/AN/A
VersionEdm.Int32falsefalse true N/AN/AN/AN/AN/A
ViewedEdm.Booleanfalsefalse true N/AN/AN/AN/AN/A

TaskInstance Navigational Properties

PropertyType
AssigneeNlyte.Model.Assignee
AssigneesCollection(Nlyte.Model.Assignee)
ControlValuesCollection(Nlyte.Model.FormInstanceControlValue)
FilesCollection(Nlyte.Model.TaskInstanceFile)
IssuesCollection(Nlyte.Model.Issue)
NotesCollection(Nlyte.Model.TaskInstanceNote)
ServiceRequestNlyte.Model.ServiceRequest
TaskNlyte.Model.Task
TaskInstanceIntegrationAttributesNlyte.Model.TaskInstanceIntegrationAttributes



TaskInstanceFile Entity : File

Verb(s)Required Permission(s)LinkDescription
GetWS-ReadFile
DeleteWS-ModifyFile

Key(s)
Name

TaskInstanceFile Structural Properties

No structural properties

TaskInstanceFile Navigational Properties

No navigational properties


TaskInstanceIntegrationAttributes Entity

Verb(s)Required Permission(s)LinkDescription

Key(s)
TaskInstanceId

TaskInstanceIntegrationAttributes Structural Properties

PropertyTypeNullableMandatoryRead-OnlyString lengthMin ValueMax ValuePrecisionMax Dec PlacesIs Only DateDescription
ErrorDetailsEdm.Stringtruefalse false N/AN/AN/AN/AN/A
NumberOfRetriesEdm.Int32truefalse false N/AN/AN/AN/AN/A
OnErrorActionEdm.Int32falsefalse false N/AN/AN/AN/AN/A
TaskInstanceIdEdm.Int32truefalse false N/AN/AN/AN/AN/A

TaskInstanceIntegrationAttributes Navigational Properties

PropertyType
TaskInstanceNlyte.Model.TaskInstance



TaskInstanceNote Entity : Note

Verb(s)Required Permission(s)LinkDescription
PostWS-AddNote
PatchWS-ModifyNote
DeleteWS-ModifyNote
GetWS-ReadNote

Key(s)
NoteID

TaskInstanceNote Structural Properties

No structural properties

TaskInstanceNote Navigational Properties

No navigational properties


TaskIntegrationAttributes Entity

Verb(s)Required Permission(s)LinkDescription

Key(s)
ID

TaskIntegrationAttributes Structural Properties

PropertyTypeNullableMandatoryRead-OnlyString lengthMin ValueMax ValuePrecisionMax Dec PlacesIs Only DateDescription
FormControlIDEdm.Int32truefalse false N/AN/AN/AN/AN/A
IDEdm.Int32falsefalse false N/AN/AN/AN/AN/A
IntegrationActivityParameterIDEdm.Int32truefalse false N/AN/AN/AN/AN/A
TaskIDEdm.Int32truefalse true N/AN/AN/AN/AN/A

TaskIntegrationAttributes Navigational Properties

PropertyType
FormControlNlyte.Model.FormControl
IntegrationActivityParameterNlyte.Model.IntegrationActivityParameter
TaskNlyte.Model.Task



TextAreaControl Entity : FormControl

Verb(s)Required Permission(s)LinkDescription

Key(s)
ID

TextAreaControl Structural Properties

PropertyTypeNullableMandatoryRead-OnlyString lengthMin ValueMax ValuePrecisionMax Dec PlacesIs Only DateDescription
MaxLengthEdm.Int32truefalse false N/AN/AN/AN/AN/A
RowSpanEdm.Int32falsetrue false N/AN/AN/AN/AN/A

TextAreaControl Navigational Properties

No navigational properties


TextAreaControlValue Entity : FormInstanceControlValue

Verb(s)Required Permission(s)LinkDescription

Key(s)
ID

TextAreaControlValue Structural Properties

No structural properties

TextAreaControlValue Navigational Properties

No navigational properties


TextInputControl Entity : FormControl

Verb(s)Required Permission(s)LinkDescription

Key(s)
ID

TextInputControl Structural Properties

PropertyTypeNullableMandatoryRead-OnlyString lengthMin ValueMax ValuePrecisionMax Dec PlacesIs Only DateDescription
IsNumericEdm.Booleanfalsefalse false N/AN/AN/AN/AN/A
MaxLengthEdm.Int32truefalse false N/AN/AN/AN/AN/A

TextInputControl Navigational Properties

No navigational properties


TextInputControlValue Entity : FormInstanceControlValue

Verb(s)Required Permission(s)LinkDescription

Key(s)
ID

TextInputControlValue Structural Properties

No structural properties

TextInputControlValue Navigational Properties

No navigational properties


TraceAsset Entity

Verb(s)Required Permission(s)LinkDescription

Key(s)
HostingAssetID

TraceAsset Structural Properties

PropertyTypeNullableMandatoryRead-OnlyString lengthMin ValueMax ValuePrecisionMax Dec PlacesIs Only DateDescription
AssetNameEdm.Stringtruefalse false N/AN/AN/AN/AN/A
AssetNumberEdm.Int32truefalse false N/AN/AN/AN/AN/A
AvailableKWEdm.Decimaltruefalse false N/AN/AN/AN/AN/A
CabinetAssetIDEdm.Int32truefalse false N/AN/AN/AN/AN/A
CabinetNameEdm.Stringtruefalse false N/AN/AN/AN/AN/A
ChassisAssetIDEdm.Int32truefalse false N/AN/AN/AN/AN/A
ConsumedKW1Edm.Decimaltruefalse false N/AN/AN/AN/AN/A
ConsumedKW2Edm.Decimaltruefalse false N/AN/AN/AN/AN/A
ConsumedKW3Edm.Decimaltruefalse false N/AN/AN/AN/AN/A
ConsumedKWTotalEdm.Decimaltruefalse false N/AN/AN/AN/AN/A
FreeCopperPortsEdm.Int32truefalse false N/AN/AN/AN/AN/A
FreeFibrePortsEdm.Int32truefalse false N/AN/AN/AN/AN/A
HostingAssetIDEdm.Int32falsefalse false N/AN/AN/AN/AN/A
IsAccessibleEdm.Booleanfalsefalse false N/AN/AN/AN/AN/A
IsMasterRedundancyDeviceEdm.Booleantruefalse false N/AN/AN/AN/AN/A
MaterialIDEdm.Int32truefalse false N/AN/AN/AN/AN/A
MaterialNameEdm.Stringtruefalse false N/AN/AN/AN/AN/A
MaterialSubtypeIDEdm.Int32truefalse false N/AN/AN/AN/AN/A
MaterialTypeIDEdm.Int32truefalse false N/AN/AN/AN/AN/A
OperationalStatusNlyte.Model.OperationalStatusEnumfalsefalse false N/AN/AN/AN/AN/A
PowerStateEdm.Booleantruefalse false N/AN/AN/AN/AN/A
RecordStatusNlyte.Model.RecordStatusEnumfalsefalse false N/AN/AN/AN/AN/A
TotalCopperPortsEdm.Int32truefalse false N/AN/AN/AN/AN/A
TotalFibrePortsEdm.Int32truefalse false N/AN/AN/AN/AN/A
Wire1PhaseEdm.Int32truefalse false N/AN/AN/AN/AN/A
Wire2PhaseEdm.Int32truefalse false N/AN/AN/AN/AN/A
Wire3PhaseEdm.Int32truefalse false N/AN/AN/AN/AN/A

TraceAsset Navigational Properties

PropertyType
LocationGroupNlyte.Model.LocationGroup



TraceLink Entity

Verb(s)Required Permission(s)LinkDescription

Key(s)
StartPortKey
EndPortKey

TraceLink Structural Properties

PropertyTypeNullableMandatoryRead-OnlyString lengthMin ValueMax ValuePrecisionMax Dec PlacesIs Only DateDescription
DistanceEdm.Int32falsefalse false N/AN/AN/AN/AN/Anon-zero Integer value describing number of links away from the Port represented by the PortID parameter: Negative values represent an initial Cable Connection
EndAssetIDEdm.Int32truefalse false N/AN/AN/AN/AN/A
EndPortIDEdm.Int32truefalse false N/AN/AN/AN/AN/A
EndPortKeyEdm.Int32falsefalse false N/AN/AN/AN/AN/A
EndPortLocationNlyte.Model.PortLocationtruefalse false N/AN/AN/AN/AN/A
EndPortStateNlyte.Model.PortStatetruefalse false N/AN/AN/AN/AN/A
GraphIDEdm.Int32truefalse false N/AN/AN/AN/AN/A
HostingEndAssetIDEdm.Int32truefalse false N/AN/AN/AN/AN/A
HostingStartAssetIDEdm.Int32truefalse false N/AN/AN/AN/AN/A
StartAssetIDEdm.Int32truefalse false N/AN/AN/AN/AN/A
StartPortIDEdm.Int32truefalse false N/AN/AN/AN/AN/A
StartPortKeyEdm.Int32falsefalse false N/AN/AN/AN/AN/A
StartPortLocationNlyte.Model.PortLocationtruefalse false N/AN/AN/AN/AN/A
StartPortStateNlyte.Model.PortStatetruefalse false N/AN/AN/AN/AN/A

TraceLink Navigational Properties

PropertyType
EndAssetNlyte.Model.Asset
EndPortNlyte.Model.NetworkPort
GraphNlyte.Model.NetworkGraph
HostingEndAssetNlyte.Model.Asset
HostingStartAssetNlyte.Model.Asset
StartAssetNlyte.Model.Asset
StartPortNlyte.Model.NetworkPort



TraceSummary Entity

Verb(s)Required Permission(s)LinkDescription

Key(s)
ID

TraceSummary Structural Properties

PropertyTypeNullableMandatoryRead-OnlyString lengthMin ValueMax ValuePrecisionMax Dec PlacesIs Only DateDescription
IDEdm.Int32falsefalse false N/AN/AN/AN/AN/A

TraceSummary Navigational Properties

PropertyType
ConnectionsCollection(Nlyte.Model.CableConnection)
TraceAssetsCollection(Nlyte.Model.TraceAsset)



TransformerAuxiliaryMaterial Entity : AuxiliaryMaterial

Verb(s)Required Permission(s)LinkDescription
GetWS-ReadAuxiliaryMaterialintegration/api/odata/TransformerAuxiliaryMaterials, integration/api/odata/TransformerAuxiliaryMaterials({key})
PostWS-AddAuxiliaryMaterialintegration/api/odata/TransformerAuxiliaryMaterials
PostWithKeyWS-ModifyAuxiliaryMaterial
PatchWS-ModifyAuxiliaryMaterialintegration/api/odata/TransformerAuxiliaryMaterials({key})
DeleteWS-ModifyAuxiliaryMaterialintegration/api/odata/TransformerAuxiliaryMaterials({key})

Key(s)
MaterialID

TransformerAuxiliaryMaterial Structural Properties

No structural properties

TransformerAuxiliaryMaterial Navigational Properties

No navigational properties


UMounting Entity - Entity representing details about the Cabinet U in which an asset is mounted.

Verb(s)Required Permission(s)LinkDescription
GetWS-ReadCabinetMountedAssetMap
PostWS-AddCabinetMountedAssetMap
PostWithKeyWS-ModifyCabinetMountedAssetMap
PatchWS-ModifyCabinetMountedAssetMap
DeleteWS-ModifyCabinetMountedAssetMap

Key(s)
UMountingID

UMounting Structural Properties

PropertyTypeNullableMandatoryRead-OnlyString lengthMin ValueMax ValuePrecisionMax Dec PlacesIs Only DateDescription
AutoConnectNetworkSubTypeNlyte.Model.NetworkSubTypeEnumfalsefalse false N/AN/AN/AN/AN/A
CabinetAssetIDEdm.Int32truefalse false N/AN/AN/AN/AN/AThe cabinet asset ID in which the asset is mounted.
CabinetUNumberEdm.Int32truefalse true N/AN/AN/AN/AN/AThe U position in which the asset is mounted.
LowerCabinetUEdm.Int32falsefalse false N/AN/AN/AN/AN/AThe bottom U position in which the asset is mounted.
MountingPlacementNlyte.Model.MountingPlacementtrue false
MountingRotationNlyte.Model.MountingRotationtrue false
MountingSideNlyte.Model.MountingSidetrue false
UDisplayLabelEdm.Int32falsefalse false N/AN/AN/AN/AN/AThe U label to be displayed, representing the top or the bottom U position, depending on the admin parameter
UMountingIDEdm.Int32falsefalse true N/AN/AN/AN/AN/APrimary key identifying the UMounting entity
XOffsetEdm.Doublefalsefalse false N/AN/AN/AN/AN/A
XRotationEdm.Doublefalsefalse false N/AN/AN/AN/AN/A
YOffsetEdm.Doublefalsefalse false N/AN/AN/AN/AN/A
YRotationEdm.Doublefalsefalse false N/AN/AN/AN/AN/A
ZOffsetEdm.Doublefalsefalse false N/AN/AN/AN/AN/A
ZRotationEdm.Doublefalsefalse false N/AN/AN/AN/AN/A

UMounting Navigational Properties

PropertyType
CabinetUNlyte.Model.CabinetU



UnplacedRoom Entity

Verb(s)Required Permission(s)LinkDescription
GetWS-ReadRoomPlan
PatchWS-ModifyRoomPlan
PutWS-ModifyRoomPlan
DeleteWS-ModifyRoomPlan
PostWS-ModifyRoomPlan

Key(s)
LocationGroupId

UnplacedRoom Structural Properties

PropertyTypeNullableMandatoryRead-OnlyString lengthMin ValueMax ValuePrecisionMax Dec PlacesIs Only DateDescription
AliasEdm.Stringtruefalse false N/AN/AN/AN/AN/A
FloorIdEdm.Int32truefalse false N/AN/AN/AN/AN/A
FloorLocationGroupIdEdm.Int32truefalse false N/AN/AN/AN/AN/A
LatitudeEdm.Decimaltruefalse false N/AN/AN/AN/AN/A
LocationGroupIdEdm.Int32truefalse true N/AN/AN/AN/AN/A
LongitudeEdm.Decimaltruefalse false N/AN/AN/AN/AN/A
NameEdm.Stringtruefalse false N/AN/AN/AN/AN/A
TagEdm.Stringtruefalse false 40N/AN/AN/AN/A

UnplacedRoom Navigational Properties

PropertyType
FloorNlyte.Model.Floor
FloorLocationGroupNlyte.Model.LocationGroup
LocationGroupNlyte.Model.LocationGroup



UPS Entity : Asset - Asset created from a material of type UPS, entity inheriting the Nlyte.Model.Asset entity

Verb(s)Required Permission(s)LinkDescription
GetWS-ReadUPSintegration/api/odata/UPSs, integration/api/odata/UPSs({key})
PatchWS-ModifyUPSintegration/api/odata/UPSs({key})
PostWithKeyWS-ModifyUPSintegration/api/odata/UPSs({key})
DeleteWS-ModifyUPSintegration/api/odata/UPSs({key})
PostWS-AddUPSintegration/api/odata/UPSs

Key(s)
AssetID

UPS Structural Properties

PropertyTypeNullableMandatoryRead-OnlyString lengthMin ValueMax ValuePrecisionMax Dec PlacesIs Only DateDescription
AuditDateEdm.DateTimeOffsettruefalse false N/AN/AN/AN/AN/A
AuditStatusCorrectEdm.Booleantruefalse false N/AN/AN/AN/AN/A
AvailableAhEdm.Decimaltruefalse false N/A099999999.9999124
BatteryInstallDateEdm.DateTimeOffsettruefalse false N/AN/AN/AN/AN/AIsOnlyDate
CostPerUnitDayEdm.Decimaltruefalse false N/A0999999.9982
CurrentPowerFactorEdm.Decimaltruefalse true N/AN/AN/AN/AN/ARead-only property representing the percentage of power drawn by a PDD asset that is available to its consumers
FixedCostEdm.Decimaltruefalse false N/A0999999.9982
IsMasterRedundancyDeviceEdm.Booleanfalsefalse false N/AN/AN/AN/AN/AValue inserted by the user
LastAuditorAccountIDEdm.Int32truefalse false N/AN/AN/AN/AN/A
LastTestDateEdm.DateTimeOffsettruefalse false N/AN/AN/AN/AN/AIsOnlyDate
MaxKVAEdm.Decimaltruefalse false N/A099999999.9999124
NextTestDateEdm.DateTimeOffsettruefalse false N/AN/AN/AN/AN/AIsOnlyDate
NumberOfBatteriesEdm.Int32truefalse false N/AN/AN/AN/AN/A
OutputCountEdm.Int32falsefalse true N/AN/AN/AN/AN/A
PowerFactorOverrideEdm.Decimaltruefalse false N/A0132Value provided by the user, overriding the CurrentPowerFactor value
RealtimePowerFactorEdm.Decimaltruefalse true N/AN/AN/AN/AN/ARead-only value.

UPS Navigational Properties

PropertyType
UpsMaterialNlyte.Model.UPSMaterial
UtilitiesCollection(Nlyte.Model.Supplier)
WiresCollection(Nlyte.Model.Wire)



UPSMaterial Entity : Material - Material type inheriting properties from the base type

Verb(s)Required Permission(s)LinkDescription
GetWS-ReadUPSMaterialintegration/api/odata/UPSMaterials, integration/api/odata/UPSMaterials({key})
PostWS-AddUPSMaterialintegration/api/odata/UPSMaterials
PostWithKeyWS-ModifyUPSMaterial
PatchWS-ModifyUPSMaterialintegration/api/odata/UPSMaterials({key})
DeleteWS-ModifyUPSMaterialintegration/api/odata/UPSMaterials({key})

Key(s)
MaterialID

UPSMaterial Structural Properties

PropertyTypeNullableMandatoryRead-OnlyString lengthMin ValueMax ValuePrecisionMax Dec PlacesIs Only DateDescription
BatteryVoltageEdm.Int32truefalse false N/AN/AN/AN/AN/A
CalculatedMaxKWEdm.Decimaltruefalse true N/AN/AN/AN/AN/A
DistributorPowerFactorEdm.Decimalfalsefalse true N/AN/AN/AN/AN/A
MaterialCategoryIDEdm.Int32truefalse false N/AN/AN/AN/AN/A
MaxAEdm.Decimaltruefalse false N/A099999.99983
MaxKVAEdm.Decimaltruefalse false N/A099999999.9999124
MaxKWEdm.Decimaltruefalse false N/A099999999.9999124
MaxVEdm.Decimaltruefalse false N/A099999.99983
PowerBatteryTypeIDNlyte.Model.PowerBatteryTypeEnumtruefalse false N/AN/AN/AN/AN/A
PowerTypeIDNlyte.Model.PowerTypeEnumtruefalse true N/AN/AN/AN/AN/APower type: phased or direct current
UHeightEdm.Int64falsefalse true N/AN/AN/AN/AN/A
WorkableFootPrintFrontEdm.Doublefalsefalse false N/A0999999999999.9999164
WorkableFootPrintHeightEdm.Doublefalsefalse false N/A0999999999999.9999164
WorkableFootPrintRearEdm.Doublefalsefalse false N/A0999999999999.9999164

UPSMaterial Navigational Properties

No navigational properties


UrlLinkControl Entity : FormControl

Verb(s)Required Permission(s)LinkDescription

Key(s)
ID

UrlLinkControl Structural Properties

PropertyTypeNullableMandatoryRead-OnlyString lengthMin ValueMax ValuePrecisionMax Dec PlacesIs Only DateDescription
IncludeServiceRequestIdEdm.Booleanfalsetrue false N/AN/AN/AN/AN/A
ParameterNameEdm.Stringtruefalse false N/AN/AN/AN/AN/A
TextEdm.Stringtruefalse false N/AN/AN/AN/AN/A
UrlEdm.Stringtruefalse false N/AN/AN/AN/AN/A

UrlLinkControl Navigational Properties

No navigational properties


UrlLinkControlValue Entity : FormInstanceControlValue

Verb(s)Required Permission(s)LinkDescription

Key(s)
ID

UrlLinkControlValue Structural Properties

No structural properties

UrlLinkControlValue Navigational Properties

No navigational properties


UserAccount Entity

Verb(s)Required Permission(s)LinkDescription

Key(s)
UserAccountID

UserAccount Structural Properties

PropertyTypeNullableMandatoryRead-OnlyString lengthMin ValueMax ValuePrecisionMax Dec PlacesIs Only DateDescription
ResourceIDEdm.Int32truefalse false N/AN/AN/AN/AN/A
UserAccountIDEdm.Int32falsefalse false N/AN/AN/AN/AN/A
UsernameEdm.Stringfalsetrue false 50N/AN/AN/AN/A
UserRoleIDEdm.Int32truefalse false N/AN/AN/AN/AN/A

UserAccount Navigational Properties

PropertyType
LocationGroupsCollection(Nlyte.Model.LocationGroup)
ResourceNlyte.Model.Resource
UserAccountPermissionsCollection(Nlyte.Model.UserAccountPermission)
UserGroupsCollection(Nlyte.Model.UserGroup)



UserAccountPermission Entity

Verb(s)Required Permission(s)LinkDescription

Key(s)
UserAccountPermissionID

UserAccountPermission Structural Properties

PropertyTypeNullableMandatoryRead-OnlyString lengthMin ValueMax ValuePrecisionMax Dec PlacesIs Only DateDescription
PermissionIDEdm.Int32truefalse false N/AN/AN/AN/AN/A
StateEdm.Int32falsefalse false N/AN/AN/AN/AN/A
UserAccountIDEdm.Int32truefalse false N/AN/AN/AN/AN/A
UserAccountPermissionIDEdm.Int32falsefalse false N/AN/AN/AN/AN/A

UserAccountPermission Navigational Properties

PropertyType
PermissionNlyte.Model.Permission
UserAccountNlyte.Model.UserAccount



UserEffectivePermission Entity

Verb(s)Required Permission(s)LinkDescription

Key(s)
Name

UserEffectivePermission Structural Properties

PropertyTypeNullableMandatoryRead-OnlyString lengthMin ValueMax ValuePrecisionMax Dec PlacesIs Only DateDescription
NameEdm.Stringfalsefalse false N/AN/AN/AN/AN/A
StateEdm.Int32falsefalse false N/AN/AN/AN/AN/A

UserEffectivePermission Navigational Properties

No navigational properties


UserGroup Entity

Verb(s)Required Permission(s)LinkDescription

Key(s)
UserGroupID

UserGroup Structural Properties

PropertyTypeNullableMandatoryRead-OnlyString lengthMin ValueMax ValuePrecisionMax Dec PlacesIs Only DateDescription
DetailEdm.Stringtruefalse false 255N/AN/AN/AN/AUser group description
EmailEdm.Stringtruefalse false 254N/AN/AN/AN/A
LdapUrlEdm.Stringtruefalse false 1024N/AN/AN/AN/A
UserGroupIDEdm.Int32falsefalse false N/AN/AN/AN/AN/A

UserGroup Navigational Properties

PropertyType
LocationGroupsCollection(Nlyte.Model.LocationGroup)



UserGroupPermission Entity

Verb(s)Required Permission(s)LinkDescription

Key(s)
UserGroupPermissionID

UserGroupPermission Structural Properties

PropertyTypeNullableMandatoryRead-OnlyString lengthMin ValueMax ValuePrecisionMax Dec PlacesIs Only DateDescription
PermissionIDEdm.Int32truefalse false N/AN/AN/AN/AN/A
StateEdm.Int32falsefalse false N/AN/AN/AN/AN/A
UserGroupIDEdm.Int32truefalse false N/AN/AN/AN/AN/A
UserGroupPermissionIDEdm.Int32falsefalse false N/AN/AN/AN/AN/A

UserGroupPermission Navigational Properties

PropertyType
PermissionNlyte.Model.Permission
UserGroupNlyte.Model.UserGroup



Wall Entity

Verb(s)Required Permission(s)LinkDescription
GetWS-ReadRoomPlan
PatchWS-ModifyRoomPlan
PutWS-ModifyRoomPlan
DeleteWS-ModifyRoomPlan
PostWS-ModifyRoomPlan

Key(s)
ID

Wall Structural Properties

PropertyTypeNullableMandatoryRead-OnlyString lengthMin ValueMax ValuePrecisionMax Dec PlacesIs Only DateDescription
IDEdm.Int32falsetrue false N/AN/AN/AN/AN/A
LayerIDEdm.Int32truetrue false N/AN/AN/AN/AN/A
NameEdm.Stringtruefalse false 50N/AN/AN/AN/A
ParentLocationGroupIDEdm.Int32truefalse true N/AN/AN/AN/AN/A
PolygonIDEdm.Int32truefalse true N/AN/AN/AN/AN/A
SaveActionNlyte.Model.SaveActionEnumfalsefalse false N/AN/AN/AN/AN/A

Wall Navigational Properties

PropertyType
LayerNlyte.Model.RoomLayer
LocationGroupNlyte.Model.LocationGroup
PolygonNlyte.Model.Polygon
RoomNlyte.Model.Room



Warning Entity

Verb(s)Required Permission(s)LinkDescription

Key(s)
ID

Warning Structural Properties

PropertyTypeNullableMandatoryRead-OnlyString lengthMin ValueMax ValuePrecisionMax Dec PlacesIs Only DateDescription
IDEdm.Int32falsefalse false N/AN/AN/AN/AN/A
TaskContainerIdEdm.Int32truefalse false N/AN/AN/AN/AN/A
WarningDescriptionEdm.Stringtruefalse false N/AN/AN/AN/AN/A

Warning Navigational Properties

No navigational properties


Warranty Entity

Verb(s)Required Permission(s)LinkDescription

Key(s)
AssetID

Warranty Structural Properties

PropertyTypeNullableMandatoryRead-OnlyString lengthMin ValueMax ValuePrecisionMax Dec PlacesIs Only DateDescription
AssetIDEdm.Int32truefalse false N/AN/AN/AN/AN/A
CommentsEdm.Stringtruefalse false 1000N/AN/AN/AN/A
ContractNumberEdm.Stringtruefalse false 40N/AN/AN/AN/A
DiscountEndDateEdm.DateTimeOffsettruefalse false N/AN/AN/AN/AN/AIsOnlyDate
LeasePriceEdm.Stringtruefalse false 1000N/AN/AN/AN/A
PurchaseDateEdm.DateTimeOffsettruefalse false N/AN/AN/AN/AN/AIsOnlyDate
RefNumberEdm.Stringtruefalse false 40N/AN/AN/AN/A
RenewalDateEdm.DateTimeOffsettruefalse false N/AN/AN/AN/AN/AIsOnlyDate
VendorEdm.Stringtruefalse false 1000N/AN/AN/AN/A
WarrantyCostCenterEdm.Stringtruefalse false 1000N/AN/AN/AN/A
WarrantyLevelEdm.Stringtruefalse false 1000N/AN/AN/AN/A
WarrantyStatusEdm.Stringtruefalse false 1000N/AN/AN/AN/A

Warranty Navigational Properties

PropertyType
AssetNlyte.Model.Asset



Wire Entity - Entity providing details on power values per wire

Verb(s)Required Permission(s)LinkDescription

Key(s)
WireID

Wire Structural Properties

PropertyTypeNullableMandatoryRead-OnlyString lengthMin ValueMax ValuePrecisionMax Dec PlacesIs Only DateDescription
AssetIDEdm.Int32truefalse false N/AN/AN/AN/AN/AThe asset ID holding the wire, the power distributor asset
AvailableKWEdm.Decimaltruefalse false N/AN/AN/AN/AN/A
CommittedKVAEdm.Decimaltruefalse false N/AN/AN/AN/AN/A
IsPoweredEdm.Booleanfalsefalse false N/AN/AN/AN/AN/A
PhaseEdm.Int32truefalse false N/AN/AN/AN/AN/A
PositionEdm.Int32falsefalse false N/AN/AN/AN/AN/AWire position
UnCommittedKWEdm.Decimaltruefalse false N/AN/AN/AN/AN/A
UsedKVAEdm.Decimaltruefalse false N/AN/AN/AN/AN/APower load draw value for the wire
WireIDEdm.Int32falsefalse false N/AN/AN/AN/AN/A

Wire Navigational Properties

PropertyType
DistributorNlyte.Model.Asset
OutputConnectorWiresCollection(Nlyte.Model.OutputConnectorWire)



WorkingHours Entity

Verb(s)Required Permission(s)LinkDescription

Key(s)
ID

WorkingHours Structural Properties

PropertyTypeNullableMandatoryRead-OnlyString lengthMin ValueMax ValuePrecisionMax Dec PlacesIs Only DateDescription
AssigneeIDEdm.Int32truetrue false N/AN/AN/AN/AN/A
EndTimeEdm.Int16falsefalse false N/AN/AN/AN/AN/A
FridayEdm.Booleanfalsefalse false N/AN/AN/AN/AN/A
IDEdm.Int32falsefalse true N/AN/AN/AN/AN/A
MondayEdm.Booleanfalsefalse false N/AN/AN/AN/AN/A
SaturdayEdm.Booleanfalsefalse false N/AN/AN/AN/AN/A
StartTimeEdm.Int16falsefalse false N/AN/AN/AN/AN/A
SundayEdm.Booleanfalsefalse false N/AN/AN/AN/AN/A
ThursdayEdm.Booleanfalsefalse false N/AN/AN/AN/AN/A
TuesdayEdm.Booleanfalsefalse false N/AN/AN/AN/AN/A
WednesdayEdm.Booleanfalsefalse false N/AN/AN/AN/AN/A

WorkingHours Navigational Properties

PropertyType
AssigneeNlyte.Model.Assignee



Zone Entity : Marker

Verb(s)Required Permission(s)LinkDescription
GetWS-ReadRoomPlan
PatchWS-ModifyRoomPlan
PutWS-ModifyRoomPlan
DeleteWS-ModifyRoomPlan
PostWS-ModifyRoomPlan

Key(s)
ID

Zone Structural Properties

PropertyTypeNullableMandatoryRead-OnlyString lengthMin ValueMax ValuePrecisionMax Dec PlacesIs Only DateDescription
NameEdm.Stringtruefalse false 50N/AN/AN/AN/A
ParentLocationGroupIDEdm.Int32truefalse true N/AN/AN/AN/AN/A
RoomIdEdm.Int32truefalse true N/AN/AN/AN/AN/A
ZoneTypeIdNlyte.Model.ZoneTypefalsetrue false N/AN/AN/AN/AN/A

Zone Navigational Properties

PropertyType
LocationGroupNlyte.Model.LocationGroup
RoomNlyte.Model.Room






AirConditioningMaterials Controller

Verb(s)Required Permission(s)LinkDescription
POSTWS-ModifyAirConditioningMaterialintegration/api/odata/AirConditioningMaterials({key})
POSTWS-AddAirConditioningMaterialintegration/api/odata/AirConditioningMaterials
PATCHWS-ModifyAirConditioningMaterialintegration/api/odata/AirConditioningMaterials({key})
DELETEWS-ModifyAirConditioningMaterialintegration/api/odata/AirConditioningMaterials({key})
GETWS-ReadAirConditioningMaterialintegration/api/odata/AirConditioningMaterials
GETWS-ReadAirConditioningMaterialintegration/api/odata/AirConditioningMaterials({key})

AirConditioningMaterials Actions

ActionRequired Permission(s)LinkDescription
CancelWS-ModifyAirConditioningMaterialintegration/api/odata/AirConditioningMaterials({key})/Cancel
ActivateWS-ModifyAirConditioningMaterialintegration/api/odata/AirConditioningMaterials({key})/ActivateFunction that will move a material in Active status.
DeactivateWS-ModifyAirConditioningMaterialintegration/api/odata/AirConditioningMaterials({key})/DeactivateFunction that will move a material in Inactive status.
UploadFileWS-AddFileintegration/api/odata/AirConditioningMaterials({key})/UploadFile(File={file})
DeleteFileWS-ModifyFileintegration/api/odata/AirConditioningMaterials({key})/DeleteFile(FileName={filename})

AirConditioningMaterials Functions

FunctionRequired Permission(s)LinkDescription
DownloadFileWS-ReadFileintegration/api/odata/AirConditioningMaterials({key})/DownloadFile(FileName={filename})
GetAuditLogDataWS-ReadAuditLogintegration/api/odata/AirConditioningMaterials({key})/GetAuditLogDataFunction 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

CustomRouteRequired 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


AirConditionings Controller

Verb(s)Required Permission(s)LinkDescription
POSTWS-ModifyAirConditioningintegration/api/odata/AirConditionings({key})
POSTWS-AddAirConditioningintegration/api/odata/AirConditionings
PATCHWS-ModifyAirConditioningintegration/api/odata/AirConditionings({key})
DELETEWS-ModifyAirConditioningintegration/api/odata/AirConditionings({key})
GETWS-ReadAirConditioningintegration/api/odata/AirConditionings
GETWS-ReadAirConditioningintegration/api/odata/AirConditionings({key})

AirConditionings Actions

ActionRequired Permission(s)LinkDescription
BeginMoveWS-PlanRecycleAirConditioning, WS-PlanDecommissionAirConditioningintegration/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.
CancelMoveWS-CancelRecycleAirConditioning, WS-CancelDecommissionAirConditioningintegration/api/odata/AirConditionings({key})/CancelMoveFunction that is used to cancel planned action. The selected asset will become Active/Operational.
CompleteMoveWS-CompleteRecycleAirConditioning, WS-CompleteDecommissionAirConditioningintegration/api/odata/AirConditionings({key})/CompleteMoveFunction 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).
DirectMoveWS-SetLocationAirConditioningintegration/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.
CompleteCreationWS-ModifyAirConditioningintegration/api/odata/AirConditionings({key})/CompleteCreationFunction that moves an asset from Planned/(Pre)Procurement to Active/Operational.
SetMaterialintegration/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.
AddRealTimeValuesWS-AddAssetRealtimeDataintegration/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.
AddNetworkAssetWS-ReadNetworkConnection,WS-AddNetworkConnectionintegration/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.
RemoveNetworkAssetWS-ModifyNetworkConnectionintegration/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.
UploadFileWS-AddFileintegration/api/odata/AirConditionings({key})/UploadFile(File={file})
DeleteFileWS-ModifyFileintegration/api/odata/AirConditionings({key})/DeleteFile(FileName={filename})

AirConditionings Functions

FunctionRequired Permission(s)LinkDescription
GetTotalSystemPowerConsumptionWS-ReadAirConditioningintegration/api/odata/AirConditionings({key})/GetTotalSystemPowerConsumptionFunction that returns the TotalSystemPowerConsumption for the selected asset.
GetRealTimePowerInfoWS-ReadAirConditioningintegration/api/odata/AirConditionings({key})/GetRealTimePowerInfo
GetDiscoveryAssetPageWS-ReadAirConditioningintegration/api/odata/AirConditionings({key})/GetDiscoveryAssetPageFunction that returns a collection of entities of type Nlyte.Model.AssetMapping. Used to determine external providers.
RecordModifiedInfoWS-ReadAirConditioningintegration/api/odata/AirConditionings({key})/RecordModifiedInfoFunction that returns an entity of type Nlyte.Model.AuditLogInfo and provides information regarding last modifications against the current asset
GetMountedChildAssetsintegration/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.
GetDistributorsWithFreeOutletsWS-ReadAssetToAssetMappingintegration/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.
SearchAssetNetworkPortLinkageWS-ReadNetworkConnectionintegration/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.
GetRealTimeValuesWS-ReadAssetRealtimeDataintegration/api/odata/AirConditionings({key})/GetRealTimeValuesFunction that returns a collection of entities of type Nlyte.Model.RealTimeValue.
GetAssetSummariesintegration/api/odata/AirConditionings({key})/GetAssetSummaries(OwnedPeripherals={ownedperipherals}, IncludeHosts={includehosts})
ListPowerConsumersintegration/api/odata/AirConditionings({key})/ListPowerConsumersFunction that returns a collection of Nlyte.Model.Graph entities. Used to identify available Output Connector used in power connections.
SupportsPlannedMoveintegration/api/odata/AirConditionings({key})/SupportsPlannedMove
GetTotalSystemWeightintegration/api/odata/AirConditionings({key})/GetTotalSystemWeightFunction that returns the TotalSystemWeight for the selected asset.
GetMountedOnAssetIDintegration/api/odata/AirConditionings({key})/GetMountedOnAssetID
GetAssetsReportDataWS-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-ReadServerHostintegration/api/odata/AirConditionings/GetAssetsReportData(assetIds={assetids})
DownloadFileWS-ReadFileintegration/api/odata/AirConditionings({key})/DownloadFile(FileName={filename})
GetAuditLogDataWS-ReadAuditLogintegration/api/odata/AirConditionings({key})/GetAuditLogDataFunction 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

CustomRouteRequired 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})/CustomFieldsWS-ReadCustomFieldAirConditioning GET
integration/api/odata/AirConditionings({key})/CustomFieldsWS-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})/WarrantyWS-ReadAirConditioning GET
integration/api/odata/AirConditionings({key})/WarrantyWS-ModifyAirConditioning POST
integration/api/odata/AirConditionings({key})/WarrantyWS-ModifyAirConditioning PATCH
integration/api/odata/AirConditionings({key})/WarrantyWS-ModifyAirConditioning DELETE
integration/api/odata/AirConditionings({key})/MaintenanceWS-ReadAirConditioning GET
integration/api/odata/AirConditionings({key})/MaintenanceWS-ModifyAirConditioning POST
integration/api/odata/AirConditionings({key})/MaintenanceWS-ModifyAirConditioning PATCH
integration/api/odata/AirConditionings({key})/MaintenanceWS-ModifyAirConditioning DELETE
integration/api/odata/AirConditionings({key})/AssetMounting GET
integration/api/odata/AirConditionings({key})/OwnershipWS-ReadBusinessGroupAssetMap GET
integration/api/odata/AirConditionings({key})/Ownership({relatedKey})WS-ReadBusinessGroupAssetMap GET
integration/api/odata/AirConditionings({key})/OwnershipWS-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})/SupportWS-ReadSupportGroupAssetMap GET
integration/api/odata/AirConditionings({key})/Support({relatedKey})WS-ReadSupportGroupAssetMap GET
integration/api/odata/AirConditionings({key})/SupportWS-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

NestedPropertySupported 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



AssetRealTimeData Controller

Verb(s)Required Permission(s)LinkDescription
GETWS-ReadAssetRealtimeDataintegration/api/odata/AssetRealTimeData
GETWS-ReadAssetRealtimeDataintegration/api/odata/AssetRealTimeData({key})

AssetRealTimeData Actions

No actions

AssetRealTimeData Functions

No functions

AssetRealTimeData Custom Routes

CustomRouteRequired 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


AssetRealTimePhaseData Controller

Verb(s)Required Permission(s)LinkDescription
GETWS-ReadAssetRealtimePhaseDataintegration/api/odata/AssetRealTimePhaseData
GETWS-ReadAssetRealtimePhaseDataintegration/api/odata/AssetRealTimePhaseData({key})

AssetRealTimePhaseData Actions

No actions

AssetRealTimePhaseData Functions

No functions

AssetRealTimePhaseData Custom Routes

CustomRouteRequired 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


Assets Controller

Verb(s)Required Permission(s)LinkDescription
POSTintegration/api/odata/Assets
POSTintegration/api/odata/Assets({key})
PATCHintegration/api/odata/Assets({key})
DELETEintegration/api/odata/Assets({key})
GETWS-ReadCabinet,WS-ReadServer,WS-ReadUPS,WS-ReadNetwork,WS-ReadPeripheral,WS-ReadStaticSwitch,WS-ReadReceptacle,WS-ReadKVMSwitch,WS-ReadAuxiliary,WS-ReadAirConditioning,WS-ReadChassis,WS-ReadPDU,WS-ReadPowerStripintegration/api/odata/Assets
GETWS-ReadCabinet,WS-ReadServer,WS-ReadUPS,WS-ReadNetwork,WS-ReadPeripheral,WS-ReadStaticSwitch,WS-ReadReceptacle,WS-ReadKVMSwitch,WS-ReadAuxiliary,WS-ReadAirConditioning,WS-ReadChassis,WS-ReadPDU,WS-ReadPowerStripintegration/api/odata/Assets({key})

Assets Actions

ActionRequired Permission(s)LinkDescription
SetMaterialintegration/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.
BeginMoveintegration/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.
CompleteMoveintegration/api/odata/Assets({key})/CompleteMoveFunction 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).
CancelMoveintegration/api/odata/Assets({key})/CancelMoveFunction that is used to cancel planned action. The selected asset will become Active/Operational.
DirectMoveintegration/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.
AddNetworkAssetWS-ReadNetworkConnection,WS-AddNetworkConnectionintegration/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.
RemoveNetworkAssetWS-ModifyNetworkConnectionintegration/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.
CompleteCreationintegration/api/odata/Assets({key})/CompleteCreationFunction that moves an asset from Planned/(Pre)Procurement to Active/Operational.
UploadFileWS-AddFileintegration/api/odata/Assets({key})/UploadFile(File={file})
DeleteFileWS-ModifyFileintegration/api/odata/Assets({key})/DeleteFile(FileName={filename})

Assets Functions

FunctionRequired Permission(s)LinkDescription
ListLinkedRecordsWS-ReadServerHost, WS-ReadPeripheralintegration/api/odata/Assets/ListLinkedRecords(assetIds={assetids})
HasTraceConnectionsWS-ReadNetworkConnection, WS-ReadAssetToAssetMappingintegration/api/odata/Assets({key})/HasTraceConnections
GetNetworkAndPowerConnectionsWS-ReadNetworkConnection, WS-ReadAssetToAssetMappingintegration/api/odata/Assets({key})/GetNetworkAndPowerConnections(filters={filters}, filterAssetIDs={filterassetids}, showPowerChain={showpowerchain}, groupChassis={groupchassis})
GetNetworkAndPowerConnectionsForExportWS-ReadNetworkConnection, WS-ReadAssetToAssetMappingintegration/api/odata/Assets({key})/GetNetworkAndPowerConnectionsForExport(filters={filters}, filterAssetIDs={filterassetids}, showPowerChain={showpowerchain})
GetMountedChildAssetsintegration/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.
GetDistributorsWithFreeOutletsWS-ReadAssetToAssetMappingintegration/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.
SearchAssetNetworkPortLinkageWS-ReadNetworkConnectionintegration/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.
ListPowerConsumersintegration/api/odata/Assets({key})/ListPowerConsumersFunction that returns a collection of Nlyte.Model.Graph entities. Used to identify available Output Connector used in power connections.
GetDiscoveryAssetPageintegration/api/odata/Assets({key})/GetDiscoveryAssetPageFunction that returns a collection of entities of type Nlyte.Model.AssetMapping. Used to determine external providers.
GetAssetsReportDataWS-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-ReadServerHostintegration/api/odata/Assets/GetAssetsReportData(assetIds={assetids})
DownloadFileWS-ReadFileintegration/api/odata/Assets({key})/DownloadFile(FileName={filename})

Assets Custom Routes

CustomRouteRequired 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

NestedPropertySupported 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



AssetsAndHosts Controller

Verb(s)Required Permission(s)LinkDescription
GETWS-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-ReadServerHostintegration/api/odata/AssetsAndHosts
GETWS-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-ReadServerHostintegration/api/odata/AssetsAndHosts({key})

AssetsAndHosts Actions

No actions

AssetsAndHosts Functions

No functions

AssetsAndHosts Custom Routes

CustomRouteRequired 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


AssetTemplateInstances Controller

Verb(s)Required Permission(s)LinkDescription
POSTWS-BeginInstantiateTemplateintegration/api/odata/AssetTemplateInstances
GETintegration/api/odata/AssetTemplateInstances
GETintegration/api/odata/AssetTemplateInstances({key})

AssetTemplateInstances Actions

No actions

AssetTemplateInstances Functions

No functions

AssetTemplateInstances Custom Routes

No custom routes

AssetTemplateInstances Nested Properties

No nested properties


AssetTemplateJobs Controller

Verb(s)Required Permission(s)LinkDescription
GETWS-ReadAssetTemplateintegration/api/odata/AssetTemplateJobs
GETWS-ReadAssetTemplateintegration/api/odata/AssetTemplateJobs({key})

AssetTemplateJobs Actions

No actions

AssetTemplateJobs Functions

No functions

AssetTemplateJobs Custom Routes

CustomRouteRequired 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})/CancelWS-CancelInstantiateTemplate POST
integration/api/odata/AssetTemplateJobs({jobid})/CompleteWS-BeginInstantiateTemplate POST

AssetTemplateJobs Nested Properties

No nested properties


AssetTemplates Controller

Verb(s)Required Permission(s)LinkDescription
POSTWS-AddAssetTemplateintegration/api/odata/AssetTemplates
PATCHWS-ModifyAssetTemplateintegration/api/odata/AssetTemplates({key})
GETWS-ReadAssetTemplateintegration/api/odata/AssetTemplates
GETWS-ReadAssetTemplateintegration/api/odata/AssetTemplates({key})

AssetTemplates Actions

ActionRequired Permission(s)LinkDescription
GetReportForExportWS-ReadAssetTemplateintegration/api/odata/AssetTemplates({key})/GetReportForExportUsed to export values related to the selected template. Please use the following mimeType for excel export application/vnd.openxmlformats-officedocument.spreadsheetml.sheet

AssetTemplates Functions

FunctionRequired Permission(s)LinkDescription
GetTemplateRootAssetsWS-ReadAssetTemplateintegration/api/odata/AssetTemplates({key})/GetTemplateRootAssets(IncludeHosts={includehosts}, IncludeCards={includecards})

AssetTemplates Custom Routes

CustomRouteRequired 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})/ActivateWS-ModifyAssetTemplate POST
integration/api/odata/AssetTemplates({key})/DeactivateWS-ModifyAssetTemplate POST

AssetTemplates Nested Properties

No nested properties


AssetUploaderJobs Controller

Verb(s)Required Permission(s)LinkDescription
POSTWS-AssetUploadintegration/api/odata/AssetUploaderJobs
DELETEWS-AssetUploadintegration/api/odata/AssetUploaderJobs({key})
GETWS-AssetUploadintegration/api/odata/AssetUploaderJobs
GETWS-AssetUploadintegration/api/odata/AssetUploaderJobs({key})

AssetUploaderJobs Actions

No actions

AssetUploaderJobs Functions

FunctionRequired Permission(s)LinkDescription
DownloadFileWS-AssetUploadintegration/api/odata/AssetUploaderJobs({key})/DownloadFile(FileName={filename})

AssetUploaderJobs Custom Routes

CustomRouteRequired 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})/CancelWS-AssetUpload POST

AssetUploaderJobs Nested Properties

No nested properties


Assignees Controller

Verb(s)Required Permission(s)LinkDescription
GETintegration/api/odata/Assignees
GETintegration/api/odata/Assignees({key})

Assignees Actions

No actions

Assignees Functions

No functions

Assignees Custom Routes

CustomRouteRequired 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


Auxiliaries Controller

Verb(s)Required Permission(s)LinkDescription
POSTWS-ModifyAuxiliaryintegration/api/odata/Auxiliaries({key})
POSTWS-AddAuxiliaryintegration/api/odata/Auxiliaries
PATCHWS-ModifyAuxiliaryintegration/api/odata/Auxiliaries({key})
DELETEWS-ModifyAuxiliaryintegration/api/odata/Auxiliaries({key})
GETWS-ReadAuxiliaryintegration/api/odata/Auxiliaries
GETWS-ReadAuxiliaryintegration/api/odata/Auxiliaries({key})

Auxiliaries Actions

ActionRequired Permission(s)LinkDescription
BeginMoveWS-PlanRecycleAuxiliary, WS-PlanDecommissionAuxiliaryintegration/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.
CancelMoveWS-CancelRecycleAuxiliary, WS-CancelDecommissionAuxiliaryintegration/api/odata/Auxiliaries({key})/CancelMoveFunction that is used to cancel planned action. The selected asset will become Active/Operational.
CompleteMoveWS-CompleteRecycleAuxiliary, WS-CompleteDecommissionAuxiliaryintegration/api/odata/Auxiliaries({key})/CompleteMoveFunction 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).
DirectMoveWS-SetLocationAuxiliaryintegration/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.
CompleteCreationWS-ModifyAuxiliaryintegration/api/odata/Auxiliaries({key})/CompleteCreationFunction that moves an asset from Planned/(Pre)Procurement to Active/Operational.
SetMaterialintegration/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.
AddRealTimeValuesWS-AddAssetRealtimeDataintegration/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.
AddNetworkAssetWS-ReadNetworkConnection,WS-AddNetworkConnectionintegration/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.
RemoveNetworkAssetWS-ModifyNetworkConnectionintegration/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.
UploadFileWS-AddFileintegration/api/odata/Auxiliaries({key})/UploadFile(File={file})
DeleteFileWS-ModifyFileintegration/api/odata/Auxiliaries({key})/DeleteFile(FileName={filename})

Auxiliaries Functions

FunctionRequired Permission(s)LinkDescription
GetTotalSystemPowerConsumptionWS-ReadAuxiliaryintegration/api/odata/Auxiliaries({key})/GetTotalSystemPowerConsumptionFunction that returns the TotalSystemPowerConsumption for the selected asset.
GetRealTimePowerInfoWS-ReadAuxiliaryintegration/api/odata/Auxiliaries({key})/GetRealTimePowerInfo
GetDiscoveryAssetPageWS-ReadAuxiliaryintegration/api/odata/Auxiliaries({key})/GetDiscoveryAssetPageFunction that returns a collection of entities of type Nlyte.Model.AssetMapping. Used to determine external providers.
RecordModifiedInfoWS-ReadAuxiliaryintegration/api/odata/Auxiliaries({key})/RecordModifiedInfoFunction that returns an entity of type Nlyte.Model.AuditLogInfo and provides information regarding last modifications against the current asset
GetMountedChildAssetsintegration/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.
GetDistributorsWithFreeOutletsWS-ReadAssetToAssetMappingintegration/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.
SearchAssetNetworkPortLinkageWS-ReadNetworkConnectionintegration/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.
GetRealTimeValuesWS-ReadAssetRealtimeDataintegration/api/odata/Auxiliaries({key})/GetRealTimeValuesFunction that returns a collection of entities of type Nlyte.Model.RealTimeValue.
GetAssetSummariesintegration/api/odata/Auxiliaries({key})/GetAssetSummaries(OwnedPeripherals={ownedperipherals}, IncludeHosts={includehosts})
GetNetworkCardPortsInfoWS-ReadNetworkConnectionintegration/api/odata/Auxiliaries({key})/GetNetworkCardPortsInfoReturns an object of type Nlyte.Model.NetworkResults having information about Copper and Fiber Ports
GetNetworkCardPortConnectionsWS-ReadNetworkConnectionintegration/api/odata/Auxiliaries({key})/GetNetworkCardPortConnectionsReturns an object of type Nlyte.Model.NetworkResults having information about Copper and Fiber Port connections
GetNetworkAssetSummaryWS-ReadNetworkConnectionintegration/api/odata/Auxiliaries({key})/GetNetworkAssetSummaryReturns an object of type Nlyte.Model.NetworkResults having information about the networkable assets.
ListPowerConsumersintegration/api/odata/Auxiliaries({key})/ListPowerConsumersFunction that returns a collection of Nlyte.Model.Graph entities. Used to identify available Output Connector used in power connections.
SupportsPlannedMoveintegration/api/odata/Auxiliaries({key})/SupportsPlannedMove
GetTotalSystemWeightintegration/api/odata/Auxiliaries({key})/GetTotalSystemWeightFunction that returns the TotalSystemWeight for the selected asset.
GetMountedOnAssetIDintegration/api/odata/Auxiliaries({key})/GetMountedOnAssetID
GetAssetsReportDataWS-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-ReadServerHostintegration/api/odata/Auxiliaries/GetAssetsReportData(assetIds={assetids})
DownloadFileWS-ReadFileintegration/api/odata/Auxiliaries({key})/DownloadFile(FileName={filename})
GetAuditLogDataWS-ReadAuditLogintegration/api/odata/Auxiliaries({key})/GetAuditLogDataFunction 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

CustomRouteRequired 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})/CustomFieldsWS-ReadCustomFieldAuxiliary GET
integration/api/odata/Auxiliaries({key})/CustomFieldsWS-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})/WarrantyWS-ReadAuxiliary GET
integration/api/odata/Auxiliaries({key})/WarrantyWS-ModifyAuxiliary POST
integration/api/odata/Auxiliaries({key})/WarrantyWS-ModifyAuxiliary PATCH
integration/api/odata/Auxiliaries({key})/WarrantyWS-ModifyAuxiliary DELETE
integration/api/odata/Auxiliaries({key})/MaintenanceWS-ReadAuxiliary GET
integration/api/odata/Auxiliaries({key})/MaintenanceWS-ModifyAuxiliary POST
integration/api/odata/Auxiliaries({key})/MaintenanceWS-ModifyAuxiliary PATCH
integration/api/odata/Auxiliaries({key})/MaintenanceWS-ModifyAuxiliary DELETE
integration/api/odata/Auxiliaries({key})/AssetMounting GET
integration/api/odata/Auxiliaries({key})/OwnershipWS-ReadBusinessGroupAssetMap GET
integration/api/odata/Auxiliaries({key})/Ownership({relatedKey})WS-ReadBusinessGroupAssetMap GET
integration/api/odata/Auxiliaries({key})/OwnershipWS-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})/SupportWS-ReadSupportGroupAssetMap GET
integration/api/odata/Auxiliaries({key})/Support({relatedKey})WS-ReadSupportGroupAssetMap GET
integration/api/odata/Auxiliaries({key})/SupportWS-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

NestedPropertySupported 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



AuxiliaryMaterials Controller

Verb(s)Required Permission(s)LinkDescription
POSTWS-AddAuxiliaryMaterialintegration/api/odata/AuxiliaryMaterials
PATCHWS-ModifyAuxiliaryMaterialintegration/api/odata/AuxiliaryMaterials({key})
DELETEWS-ModifyAuxiliaryMaterialintegration/api/odata/AuxiliaryMaterials({key})
GETWS-ReadAuxiliaryMaterialintegration/api/odata/AuxiliaryMaterials
GETWS-ReadAuxiliaryMaterialintegration/api/odata/AuxiliaryMaterials({key})

AuxiliaryMaterials Actions

ActionRequired Permission(s)LinkDescription
CancelWS-ModifyAuxiliaryMaterialintegration/api/odata/AuxiliaryMaterials({key})/Cancel
ActivateWS-ModifyAuxiliaryMaterialintegration/api/odata/AuxiliaryMaterials({key})/ActivateFunction that will move a material in Active status.
DeactivateWS-ModifyAuxiliaryMaterialintegration/api/odata/AuxiliaryMaterials({key})/DeactivateFunction that will move a material in Inactive status.
UploadFileWS-AddFileintegration/api/odata/AuxiliaryMaterials({key})/UploadFile(File={file})
DeleteFileWS-ModifyFileintegration/api/odata/AuxiliaryMaterials({key})/DeleteFile(FileName={filename})

AuxiliaryMaterials Functions

FunctionRequired Permission(s)LinkDescription
DownloadFileWS-ReadFileintegration/api/odata/AuxiliaryMaterials({key})/DownloadFile(FileName={filename})
GetAuditLogDataWS-ReadAuditLogintegration/api/odata/AuxiliaryMaterials({key})/GetAuditLogDataFunction 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

CustomRouteRequired 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


BladeServerMaterials Controller

Verb(s)Required Permission(s)LinkDescription
POSTWS-AddServerMaterialintegration/api/odata/BladeServerMaterials
PATCHWS-ModifyServerMaterialintegration/api/odata/BladeServerMaterials({key})
DELETEWS-ModifyServerMaterialintegration/api/odata/BladeServerMaterials({key})
GETWS-ReadServerMaterialintegration/api/odata/BladeServerMaterials
GETWS-ReadServerMaterialintegration/api/odata/BladeServerMaterials({key})

BladeServerMaterials Actions

ActionRequired Permission(s)LinkDescription
CancelWS-ModifyServerMaterialintegration/api/odata/BladeServerMaterials({key})/Cancel
ActivateWS-ModifyServerMaterialintegration/api/odata/BladeServerMaterials({key})/ActivateFunction that will move a material in Active status.
DeactivateWS-ModifyServerMaterialintegration/api/odata/BladeServerMaterials({key})/DeactivateFunction that will move a material in Inactive status.
UploadFileWS-AddFileintegration/api/odata/BladeServerMaterials({key})/UploadFile(File={file})
DeleteFileWS-ModifyFileintegration/api/odata/BladeServerMaterials({key})/DeleteFile(FileName={filename})

BladeServerMaterials Functions

FunctionRequired Permission(s)LinkDescription
DownloadFileWS-ReadFileintegration/api/odata/BladeServerMaterials({key})/DownloadFile(FileName={filename})
GetAuditLogDataWS-ReadAuditLogintegration/api/odata/BladeServerMaterials({key})/GetAuditLogDataFunction 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

CustomRouteRequired 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


BoardPDUMaterials Controller

Verb(s)Required Permission(s)LinkDescription
POSTWS-AddPDUMaterialintegration/api/odata/BoardPDUMaterials
PATCHWS-ModifyPDUMaterialintegration/api/odata/BoardPDUMaterials({key})
DELETEWS-ModifyPDUMaterialintegration/api/odata/BoardPDUMaterials({key})
GETWS-ReadPDUMaterialintegration/api/odata/BoardPDUMaterials
GETWS-ReadPDUMaterialintegration/api/odata/BoardPDUMaterials({key})

BoardPDUMaterials Actions

ActionRequired Permission(s)LinkDescription
CancelWS-ModifyPDUMaterialintegration/api/odata/BoardPDUMaterials({key})/Cancel
ActivateWS-ModifyPDUMaterialintegration/api/odata/BoardPDUMaterials({key})/ActivateFunction that will move a material in Active status.
DeactivateWS-ModifyPDUMaterialintegration/api/odata/BoardPDUMaterials({key})/DeactivateFunction that will move a material in Inactive status.
UploadFileWS-AddFileintegration/api/odata/BoardPDUMaterials({key})/UploadFile(File={file})
DeleteFileWS-ModifyFileintegration/api/odata/BoardPDUMaterials({key})/DeleteFile(FileName={filename})

BoardPDUMaterials Functions

FunctionRequired Permission(s)LinkDescription
DownloadFileWS-ReadFileintegration/api/odata/BoardPDUMaterials({key})/DownloadFile(FileName={filename})
GetAuditLogDataWS-ReadAuditLogintegration/api/odata/BoardPDUMaterials({key})/GetAuditLogDataFunction 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

CustomRouteRequired 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


BreakerPanels Controller

Verb(s)Required Permission(s)LinkDescription
POSTWS-ModifyPDUPanelintegration/api/odata/BreakerPanels({key})
POSTWS-AddPDUPanelintegration/api/odata/BreakerPanels
DELETEWS-ModifyPDUPanelintegration/api/odata/BreakerPanels({key})
PATCHWS-ModifyPDUPanelintegration/api/odata/BreakerPanels({key})
GETWS-ReadPDUPanelintegration/api/odata/BreakerPanels
GETWS-ReadPDUPanelintegration/api/odata/BreakerPanels({key})

BreakerPanels Actions

No actions

BreakerPanels Functions

No functions

BreakerPanels Custom Routes

CustomRouteRequired 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

NestedPropertySupported Method(s)
Breakers POST PATCH



Breakers Controller

Verb(s)Required Permission(s)LinkDescription
DELETEWS-ModifyPDUBreakerintegration/api/odata/Breakers({key})
PATCHWS-ModifyPDUBreakerintegration/api/odata/Breakers({key})
GETWS-ReadPDUBreakerintegration/api/odata/Breakers
GETWS-ReadPDUBreakerintegration/api/odata/Breakers({key})

Breakers Actions

No actions

Breakers Functions

No functions

Breakers Custom Routes

CustomRouteRequired 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


BusBarPDUMaterials Controller

Verb(s)Required Permission(s)LinkDescription
POSTWS-AddPDUMaterialintegration/api/odata/BusBarPDUMaterials
PATCHWS-ModifyPDUMaterialintegration/api/odata/BusBarPDUMaterials({key})
DELETEWS-ModifyPDUMaterialintegration/api/odata/BusBarPDUMaterials({key})
GETWS-ReadPDUMaterialintegration/api/odata/BusBarPDUMaterials
GETWS-ReadPDUMaterialintegration/api/odata/BusBarPDUMaterials({key})

BusBarPDUMaterials Actions

ActionRequired Permission(s)LinkDescription
CancelWS-ModifyPDUMaterialintegration/api/odata/BusBarPDUMaterials({key})/Cancel
ActivateWS-ModifyPDUMaterialintegration/api/odata/BusBarPDUMaterials({key})/ActivateFunction that will move a material in Active status.
DeactivateWS-ModifyPDUMaterialintegration/api/odata/BusBarPDUMaterials({key})/DeactivateFunction that will move a material in Inactive status.
UploadFileWS-AddFileintegration/api/odata/BusBarPDUMaterials({key})/UploadFile(File={file})
DeleteFileWS-ModifyFileintegration/api/odata/BusBarPDUMaterials({key})/DeleteFile(FileName={filename})

BusBarPDUMaterials Functions

FunctionRequired Permission(s)LinkDescription
DownloadFileWS-ReadFileintegration/api/odata/BusBarPDUMaterials({key})/DownloadFile(FileName={filename})
GetAuditLogDataWS-ReadAuditLogintegration/api/odata/BusBarPDUMaterials({key})/GetAuditLogDataFunction 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

CustomRouteRequired 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


BusinessApplications Controller

Verb(s)Required Permission(s)LinkDescription
POSTWS-AddBusinessApplicationintegration/api/odata/BusinessApplications
POSTWS-ModifyBusinessApplicationintegration/api/odata/BusinessApplications({key})
PATCHWS-ModifyBusinessApplicationintegration/api/odata/BusinessApplications({key})
DELETEWS-ModifyBusinessApplicationintegration/api/odata/BusinessApplications({key})
GETWS-ReadBusinessApplicationintegration/api/odata/BusinessApplications
GETWS-ReadBusinessApplicationintegration/api/odata/BusinessApplications({key})

BusinessApplications Actions

ActionRequired Permission(s)LinkDescription
Cancelintegration/api/odata/BusinessApplications({key})/Cancel

BusinessApplications Functions

No functions

BusinessApplications Custom Routes

CustomRouteRequired Permission(s)Supported Method(s)Description
integration/api/odata/BusinessApplications DELETE
integration/api/odata/BusinessApplications POST
integration/api/odata/BusinessApplications({key})/OwnershipWS-ReadBusinessApplicationBusinessGroupMap GET
integration/api/odata/BusinessApplications({key})/Ownership({relatedKey})WS-ReadBusinessApplicationBusinessGroupMap GET
integration/api/odata/BusinessApplications({key})/OwnershipWS-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})/SupportWS-ReadBusinessApplicationSupportGroupMap GET
integration/api/odata/BusinessApplications({key})/Support({relatedKey})WS-ReadBusinessApplicationSupportGroupMap GET
integration/api/odata/BusinessApplications({key})/SupportWS-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})/HostsWS-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

NestedPropertySupported Method(s)
Ownership BIND POST PATCH
Support BIND POST PATCH
Hosts



BusinessGroups Controller

Verb(s)Required Permission(s)LinkDescription
POSTWS-AddBusinessGroupintegration/api/odata/BusinessGroups
DELETEWS-ModifyBusinessGroupintegration/api/odata/BusinessGroups({key})
PATCHWS-ModifyBusinessGroupintegration/api/odata/BusinessGroups({key})
POSTWS-ModifyBusinessGroupintegration/api/odata/BusinessGroups({key})
GETWS-ReadBusinessGroupintegration/api/odata/BusinessGroups
GETWS-ReadBusinessGroupintegration/api/odata/BusinessGroups({key})

BusinessGroups Actions

No actions

BusinessGroups Functions

FunctionRequired Permission(s)LinkDescription
ListBusinessGroupLinkedRecordsWS-ReadBusinessGroupAssetMap,WS-ReadServerHostBusinessGroupMap,WS-ReadBusinessApplicationBusinessGroupMapintegration/api/odata/BusinessGroups/ListBusinessGroupLinkedRecords(BusinessGroupID={businessgroupid})
GetWorkingHoursWS-ReadBusinessGroupintegration/api/odata/BusinessGroups/GetWorkingHours(AssigneeID={assigneeid})
GetNonWorkingDatesWS-ReadBusinessGroupintegration/api/odata/BusinessGroups/GetNonWorkingDates(AssigneeID={assigneeid})The function will return a collection of Nlyte.Model.ExclusionDate for business groups.
GetBusinessGroupDescendantsWS-ReadBusinessGroupintegration/api/odata/BusinessGroups({key})/GetBusinessGroupDescendants(IncludeSelf={includeself})
GetBusinessGroupAscendantsAndSelfWS-ReadBusinessGroupintegration/api/odata/BusinessGroups({key})/GetBusinessGroupAscendantsAndSelf

BusinessGroups Custom Routes

CustomRouteRequired 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})/BusinessGroupContactsWS-ReadBusinessGroupResourceMap GET
integration/api/odata/BusinessGroups({key})/BusinessGroupContacts({relatedKey})WS-ReadBusinessGroupResourceMap,WS-ReadResource GET
integration/api/odata/BusinessGroups({key})/BusinessGroupContactsWS-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

NestedPropertySupported Method(s)
AssociatedBusinessGroups BIND POST PATCH
BusinessGroupContacts BIND POST PATCH



CabinetMarkers Controller

Verb(s)Required Permission(s)LinkDescription
POSTWS-AddMarkerintegration/api/odata/CabinetMarkers
DELETEintegration/api/odata/CabinetMarkers({key})
PATCHWS-ModifyMarkerintegration/api/odata/CabinetMarkers({key})
GETWS-ReadMarkerintegration/api/odata/CabinetMarkers
GETWS-ReadMarkerintegration/api/odata/CabinetMarkers({key})

CabinetMarkers Actions

No actions

CabinetMarkers Functions

No functions

CabinetMarkers Custom Routes

CustomRouteRequired 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


CabinetMaterials Controller

Verb(s)Required Permission(s)LinkDescription
POSTWS-ModifyCabinetMaterialintegration/api/odata/CabinetMaterials({key})
POSTWS-AddCabinetMaterialintegration/api/odata/CabinetMaterials
PATCHWS-ModifyCabinetMaterialintegration/api/odata/CabinetMaterials({key})
DELETEWS-ModifyCabinetMaterialintegration/api/odata/CabinetMaterials({key})
GETWS-ReadCabinetMaterialintegration/api/odata/CabinetMaterials
GETWS-ReadCabinetMaterialintegration/api/odata/CabinetMaterials({key})

CabinetMaterials Actions

ActionRequired Permission(s)LinkDescription
CancelWS-ModifyCabinetMaterialintegration/api/odata/CabinetMaterials({key})/Cancel
ActivateWS-ModifyCabinetMaterialintegration/api/odata/CabinetMaterials({key})/ActivateFunction that will move a material in Active status.
DeactivateWS-ModifyCabinetMaterialintegration/api/odata/CabinetMaterials({key})/DeactivateFunction that will move a material in Inactive status.
UploadFileWS-AddFileintegration/api/odata/CabinetMaterials({key})/UploadFile(File={file})
DeleteFileWS-ModifyFileintegration/api/odata/CabinetMaterials({key})/DeleteFile(FileName={filename})

CabinetMaterials Functions

FunctionRequired Permission(s)LinkDescription
DownloadFileWS-ReadFileintegration/api/odata/CabinetMaterials({key})/DownloadFile(FileName={filename})
GetAuditLogDataWS-ReadAuditLogintegration/api/odata/CabinetMaterials({key})/GetAuditLogDataFunction 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

CustomRouteRequired 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


Cabinets Controller

Verb(s)Required Permission(s)LinkDescription
GETWS-ReadCabinetintegration/api/odata/Cabinets
POSTWS-ModifyCabinetintegration/api/odata/Cabinets({key})
PATCHWS-ModifyCabinetintegration/api/odata/Cabinets({key})
POSTWS-AddCabinetintegration/api/odata/Cabinets
DELETEWS-ModifyCabinetintegration/api/odata/Cabinets({key})
GETWS-ReadCabinetintegration/api/odata/Cabinets({key})

Cabinets Actions

ActionRequired Permission(s)LinkDescription
BeginMoveWS-PlanRecycleCabinet, WS-PlanDecommissionCabinetintegration/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.
CancelMoveWS-CancelRecycleCabinet, WS-CancelDecommissionCabinetintegration/api/odata/Cabinets({key})/CancelMoveFunction that is used to cancel planned action. The selected asset will become Active/Operational.
CompleteMoveWS-CompleteRecycleCabinet, WS-CompleteDecommissionCabinetintegration/api/odata/Cabinets({key})/CompleteMoveFunction 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).
DirectMoveWS-SetLocationCabinetintegration/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.
CompleteCreationWS-ModifyCabinetintegration/api/odata/Cabinets({key})/CompleteCreationFunction that moves an asset from Planned/(Pre)Procurement to Active/Operational.
SetMaterialintegration/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.
AddRealTimeValuesWS-AddAssetRealtimeDataintegration/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.
AddNetworkAssetWS-ReadNetworkConnection,WS-AddNetworkConnectionintegration/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.
RemoveNetworkAssetWS-ModifyNetworkConnectionintegration/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.
UploadFileWS-AddFileintegration/api/odata/Cabinets({key})/UploadFile(File={file})
DeleteFileWS-ModifyFileintegration/api/odata/Cabinets({key})/DeleteFile(FileName={filename})

Cabinets Functions

FunctionRequired Permission(s)LinkDescription
ListLinkedRecordsintegration/api/odata/Cabinets/ListLinkedRecords(assetIds={assetids})
GetAvailableUsForMaterialintegration/api/odata/Cabinets({key})/GetAvailableUsForMaterial(MaterialID={materialid})
GetByLocationintegration/api/odata/Cabinets/GetByLocation(locationGroupID={locationgroupid})
GetMountedPowerstripsWS-ReadPowerStripintegration/api/odata/Cabinets({key})/GetMountedPowerstrips
GetTotalSystemPowerConsumptionWS-ReadCabinetintegration/api/odata/Cabinets({key})/GetTotalSystemPowerConsumptionFunction that returns the TotalSystemPowerConsumption for the selected asset.
GetRealTimePowerInfoWS-ReadCabinetintegration/api/odata/Cabinets({key})/GetRealTimePowerInfo
GetDiscoveryAssetPageWS-ReadCabinetintegration/api/odata/Cabinets({key})/GetDiscoveryAssetPageFunction that returns a collection of entities of type Nlyte.Model.AssetMapping. Used to determine external providers.
RecordModifiedInfoWS-ReadCabinetintegration/api/odata/Cabinets({key})/RecordModifiedInfoFunction that returns an entity of type Nlyte.Model.AuditLogInfo and provides information regarding last modifications against the current asset
GetCabinetAssetPanelSummaryintegration/api/odata/Cabinets/GetCabinetAssetPanelSummary(cabinetAssetIds={cabinetassetids})
GetMountedChildAssetsintegration/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.
GetDistributorsWithFreeOutletsWS-ReadAssetToAssetMappingintegration/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.
SearchAssetNetworkPortLinkageWS-ReadNetworkConnectionintegration/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.
GetRealTimeValuesWS-ReadAssetRealtimeDataintegration/api/odata/Cabinets({key})/GetRealTimeValuesFunction that returns a collection of entities of type Nlyte.Model.RealTimeValue.
GetAssetSummariesintegration/api/odata/Cabinets({key})/GetAssetSummaries(OwnedPeripherals={ownedperipherals}, IncludeHosts={includehosts})
GetNetworkCardPortsInfoWS-ReadNetworkConnectionintegration/api/odata/Cabinets({key})/GetNetworkCardPortsInfoReturns an object of type Nlyte.Model.NetworkResults having information about Copper and Fiber Ports
GetNetworkCardPortConnectionsWS-ReadNetworkConnectionintegration/api/odata/Cabinets({key})/GetNetworkCardPortConnectionsReturns an object of type Nlyte.Model.NetworkResults having information about Copper and Fiber Port connections
GetNetworkAssetSummaryWS-ReadNetworkConnectionintegration/api/odata/Cabinets({key})/GetNetworkAssetSummaryReturns an object of type Nlyte.Model.NetworkResults having information about the networkable assets.
ListPowerConsumersintegration/api/odata/Cabinets({key})/ListPowerConsumersFunction that returns a collection of Nlyte.Model.Graph entities. Used to identify available Output Connector used in power connections.
SupportsPlannedMoveintegration/api/odata/Cabinets({key})/SupportsPlannedMove
GetTotalSystemWeightintegration/api/odata/Cabinets({key})/GetTotalSystemWeightFunction that returns the TotalSystemWeight for the selected asset.
GetAssetsReportDataWS-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-ReadServerHostintegration/api/odata/Cabinets/GetAssetsReportData(assetIds={assetids})
GetConventionSetsintegration/api/odata/Cabinets/GetConventionSets(EntityTypeID={entitytypeid})
GetConventionsintegration/api/odata/Cabinets/GetConventions(ConventionSetID={conventionsetid})
GenerateConventionNameintegration/api/odata/Cabinets/GenerateConventionName(ConventionID={conventionid})
DownloadFileWS-ReadFileintegration/api/odata/Cabinets({key})/DownloadFile(FileName={filename})
GetConventionSetsintegration/api/odata/Cabinets/GetConventionSets(EntityTypeID={entitytypeid})
GetConventionsintegration/api/odata/Cabinets/GetConventions(ConventionSetID={conventionsetid})
GenerateConventionNameintegration/api/odata/Cabinets/GenerateConventionName(ConventionID={conventionid})
GetAuditLogDataWS-ReadAuditLogintegration/api/odata/Cabinets({key})/GetAuditLogDataFunction 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

CustomRouteRequired 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})/KVMSwitchesWS-AddKVMSwitchCabinetMap POST
integration/api/odata/Cabinets({key})/GetServiceRequests GET
integration/api/odata/Cabinets({key})/CustomFieldsWS-ReadCustomFieldCabinet GET
integration/api/odata/Cabinets({key})/CustomFieldsWS-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})/WarrantyWS-ReadCabinet GET
integration/api/odata/Cabinets({key})/WarrantyWS-ModifyCabinet POST
integration/api/odata/Cabinets({key})/WarrantyWS-ModifyCabinet PATCH
integration/api/odata/Cabinets({key})/WarrantyWS-ModifyCabinet DELETE
integration/api/odata/Cabinets({key})/MaintenanceWS-ReadCabinet GET
integration/api/odata/Cabinets({key})/MaintenanceWS-ModifyCabinet POST
integration/api/odata/Cabinets({key})/MaintenanceWS-ModifyCabinet PATCH
integration/api/odata/Cabinets({key})/MaintenanceWS-ModifyCabinet DELETE
integration/api/odata/Cabinets({key})/AssetMounting GET
integration/api/odata/Cabinets({key})/OwnershipWS-ReadBusinessGroupAssetMap GET
integration/api/odata/Cabinets({key})/Ownership({relatedKey})WS-ReadBusinessGroupAssetMap GET
integration/api/odata/Cabinets({key})/OwnershipWS-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})/SupportWS-ReadSupportGroupAssetMap GET
integration/api/odata/Cabinets({key})/Support({relatedKey})WS-ReadSupportGroupAssetMap GET
integration/api/odata/Cabinets({key})/SupportWS-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

NestedPropertySupported 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



CardNetworkMaterials Controller

Verb(s)Required Permission(s)LinkDescription
POSTWS-AddNetworkMaterialintegration/api/odata/CardNetworkMaterials
PATCHWS-ModifyNetworkMaterialintegration/api/odata/CardNetworkMaterials({key})
DELETEWS-ModifyNetworkMaterialintegration/api/odata/CardNetworkMaterials({key})
GETWS-ReadNetworkMaterialintegration/api/odata/CardNetworkMaterials
GETWS-ReadNetworkMaterialintegration/api/odata/CardNetworkMaterials({key})

CardNetworkMaterials Actions

ActionRequired Permission(s)LinkDescription
CancelWS-ModifyNetworkMaterialintegration/api/odata/CardNetworkMaterials({key})/Cancel
ActivateWS-ModifyNetworkMaterialintegration/api/odata/CardNetworkMaterials({key})/ActivateFunction that will move a material in Active status.
DeactivateWS-ModifyNetworkMaterialintegration/api/odata/CardNetworkMaterials({key})/DeactivateFunction that will move a material in Inactive status.
UploadFileWS-AddFileintegration/api/odata/CardNetworkMaterials({key})/UploadFile(File={file})
DeleteFileWS-ModifyFileintegration/api/odata/CardNetworkMaterials({key})/DeleteFile(FileName={filename})

CardNetworkMaterials Functions

FunctionRequired Permission(s)LinkDescription
DownloadFileWS-ReadFileintegration/api/odata/CardNetworkMaterials({key})/DownloadFile(FileName={filename})
GetAuditLogDataWS-ReadAuditLogintegration/api/odata/CardNetworkMaterials({key})/GetAuditLogDataFunction 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

CustomRouteRequired 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


CatalogTypes Controller

Verb(s)Required Permission(s)LinkDescription
GETintegration/api/odata/CatalogTypes
GETintegration/api/odata/CatalogTypes({key})

CatalogTypes Actions

No actions

CatalogTypes Functions

No functions

CatalogTypes Custom Routes

CustomRouteRequired 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


CeilingMaterials Controller

Verb(s)Required Permission(s)LinkDescription
GETWS-ReadFloorPlanintegration/api/odata/CeilingMaterials
GETWS-ReadFloorPlanintegration/api/odata/CeilingMaterials({key})

CeilingMaterials Actions

No actions

CeilingMaterials Functions

No functions

CeilingMaterials Custom Routes

CustomRouteRequired 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


Chassis Controller

Verb(s)Required Permission(s)LinkDescription
PATCHWS-ModifyChassisintegration/api/odata/Chassis({key})
POSTWS-AddChassisintegration/api/odata/Chassis
DELETEWS-ModifyChassisintegration/api/odata/Chassis({key})
POSTWS-ModifyChassisintegration/api/odata/Chassis({key})
GETWS-ReadChassisintegration/api/odata/Chassis
GETWS-ReadChassisintegration/api/odata/Chassis({key})

Chassis Actions

ActionRequired Permission(s)LinkDescription
BeginMoveWS-PlanMoveChassis, WS-PlanRecycleChassis, WS-PlanDecommissionChassisintegration/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.
CancelMoveWS-CancelMoveChassis, WS-CancelRecycleChassis, WS-CancelDecommissionChassisintegration/api/odata/Chassis({key})/CancelMoveFunction that is used to cancel planned action. The selected asset will become Active/Operational.
CompleteMoveWS-CompleteMoveChassis, WS-CompleteRecycleChassis, WS-CompleteDecommissionChassisintegration/api/odata/Chassis({key})/CompleteMoveFunction 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).
DirectMoveWS-SetLocationChassisintegration/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.
CompleteCreationWS-ModifyChassisintegration/api/odata/Chassis({key})/CompleteCreationFunction that moves an asset from Planned/(Pre)Procurement to Active/Operational.
SetMaterialintegration/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.
AddRealTimeValuesWS-AddAssetRealtimeDataintegration/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.
AddNetworkAssetWS-ReadNetworkConnection,WS-AddNetworkConnectionintegration/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.
RemoveNetworkAssetWS-ModifyNetworkConnectionintegration/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.
UploadFileWS-AddFileintegration/api/odata/Chassis({key})/UploadFile(File={file})
DeleteFileWS-ModifyFileintegration/api/odata/Chassis({key})/DeleteFile(FileName={filename})

Chassis Functions

FunctionRequired Permission(s)LinkDescription
ListLinkedRecordsintegration/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.
GetBladesInLocationWS-ReadCabinet,WS-ReadServer,WS-ReadChassis,WS-ReadServerMaterialintegration/api/odata/Chassis({key})/GetBladesInLocation(SearchTerm={searchterm}, SearchTermOption={searchtermoption}, LocationGroupID={locationgroupid}, OrientationID={orientationid})
GetStandardServersInLocationWS-ReadCabinet,WS-ReadServer,WS-ReadChassis,WS-ReadServerMaterialintegration/api/odata/Chassis({key})/GetStandardServersInLocation(SearchTerm={searchterm}, SearchTermOption={searchtermoption}, LocationGroupID={locationgroupid}, OrientationID={orientationid})
GetModulesInLocationWS-ReadCabinet,WS-ReadNetwork,WS-ReadChassis,WS-ReadNetworkMaterialintegration/api/odata/Chassis({key})/GetModulesInLocation(SearchTerm={searchterm}, SearchTermOption={searchtermoption}, LocationGroupID={locationgroupid}, OrientationID={orientationid})
GetTotalSystemPowerConsumptionWS-ReadChassisintegration/api/odata/Chassis({key})/GetTotalSystemPowerConsumptionFunction that returns the TotalSystemPowerConsumption for the selected asset.
GetAssetAllocationCriteriaWS-ReadChassisintegration/api/odata/Chassis({key})/GetAssetAllocationCriteriaUsed to retrieve Nlyte.Model.AssetAllocationCriteria representing the available allocation criteria used in auto-allocation.
GetRealTimePowerInfoWS-ReadChassisintegration/api/odata/Chassis({key})/GetRealTimePowerInfo
GetDiscoveryAssetPageWS-ReadChassisintegration/api/odata/Chassis({key})/GetDiscoveryAssetPageFunction that returns a collection of entities of type Nlyte.Model.AssetMapping. Used to determine external providers.
RecordModifiedInfoWS-ReadChassisintegration/api/odata/Chassis({key})/RecordModifiedInfoFunction that returns an entity of type Nlyte.Model.AuditLogInfo and provides information regarding last modifications against the current asset
GetMountedChildAssetsintegration/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.
GetDistributorsWithFreeOutletsWS-ReadAssetToAssetMappingintegration/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.
SearchAssetNetworkPortLinkageWS-ReadNetworkConnectionintegration/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.
GetRealTimeValuesWS-ReadAssetRealtimeDataintegration/api/odata/Chassis({key})/GetRealTimeValuesFunction that returns a collection of entities of type Nlyte.Model.RealTimeValue.
GetAssetSummariesintegration/api/odata/Chassis({key})/GetAssetSummaries(OwnedPeripherals={ownedperipherals}, IncludeHosts={includehosts})
GetNetworkCardPortsInfoWS-ReadNetworkConnectionintegration/api/odata/Chassis({key})/GetNetworkCardPortsInfoReturns an object of type Nlyte.Model.NetworkResults having information about Copper and Fiber Ports
GetNetworkCardPortConnectionsWS-ReadNetworkConnectionintegration/api/odata/Chassis({key})/GetNetworkCardPortConnectionsReturns an object of type Nlyte.Model.NetworkResults having information about Copper and Fiber Port connections
GetNetworkAssetSummaryWS-ReadNetworkConnectionintegration/api/odata/Chassis({key})/GetNetworkAssetSummaryReturns an object of type Nlyte.Model.NetworkResults having information about the networkable assets.
ListPowerConsumersintegration/api/odata/Chassis({key})/ListPowerConsumersFunction that returns a collection of Nlyte.Model.Graph entities. Used to identify available Output Connector used in power connections.
SupportsPlannedMoveintegration/api/odata/Chassis({key})/SupportsPlannedMove
GetTotalSystemWeightintegration/api/odata/Chassis({key})/GetTotalSystemWeightFunction that returns the TotalSystemWeight for the selected asset.
GetMountedOnAssetIDintegration/api/odata/Chassis({key})/GetMountedOnAssetID
GetAssetsReportDataWS-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-ReadServerHostintegration/api/odata/Chassis/GetAssetsReportData(assetIds={assetids})
GetConventionSetsintegration/api/odata/Chassis/GetConventionSets(EntityTypeID={entitytypeid})
GetConventionsintegration/api/odata/Chassis/GetConventions(ConventionSetID={conventionsetid})
GenerateConventionNameintegration/api/odata/Chassis/GenerateConventionName(ConventionID={conventionid})
DownloadFileWS-ReadFileintegration/api/odata/Chassis({key})/DownloadFile(FileName={filename})
GetConventionSetsintegration/api/odata/Chassis/GetConventionSets(EntityTypeID={entitytypeid})
GetConventionsintegration/api/odata/Chassis/GetConventions(ConventionSetID={conventionsetid})
GenerateConventionNameintegration/api/odata/Chassis/GenerateConventionName(ConventionID={conventionid})
GetAuditLogDataWS-ReadAuditLogintegration/api/odata/Chassis({key})/GetAuditLogDataFunction 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

CustomRouteRequired 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})/CustomFieldsWS-ReadCustomFieldChassis GET
integration/api/odata/Chassis({key})/CustomFieldsWS-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})/WarrantyWS-ReadChassis GET
integration/api/odata/Chassis({key})/WarrantyWS-ModifyChassis POST
integration/api/odata/Chassis({key})/WarrantyWS-ModifyChassis PATCH
integration/api/odata/Chassis({key})/WarrantyWS-ModifyChassis DELETE
integration/api/odata/Chassis({key})/MaintenanceWS-ReadChassis GET
integration/api/odata/Chassis({key})/MaintenanceWS-ModifyChassis POST
integration/api/odata/Chassis({key})/MaintenanceWS-ModifyChassis PATCH
integration/api/odata/Chassis({key})/MaintenanceWS-ModifyChassis DELETE
integration/api/odata/Chassis({key})/AssetMounting GET
integration/api/odata/Chassis({key})/OwnershipWS-ReadBusinessGroupAssetMap GET
integration/api/odata/Chassis({key})/Ownership({relatedKey})WS-ReadBusinessGroupAssetMap GET
integration/api/odata/Chassis({key})/OwnershipWS-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})/SupportWS-ReadSupportGroupAssetMap GET
integration/api/odata/Chassis({key})/Support({relatedKey})WS-ReadSupportGroupAssetMap GET
integration/api/odata/Chassis({key})/SupportWS-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/BulkUpdateChassisSlotNamesWS-ModifyChassis POST

Chassis Nested Properties

NestedPropertySupported 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



ChassisMaterials Controller

Verb(s)Required Permission(s)LinkDescription
POSTWS-ModifyChassisMaterialintegration/api/odata/ChassisMaterials({key})
POSTWS-AddChassisMaterialintegration/api/odata/ChassisMaterials
PATCHWS-ModifyChassisMaterialintegration/api/odata/ChassisMaterials({key})
DELETEWS-ModifyChassisMaterialintegration/api/odata/ChassisMaterials({key})
GETWS-ReadChassisMaterialintegration/api/odata/ChassisMaterials
GETWS-ReadChassisMaterialintegration/api/odata/ChassisMaterials({key})

ChassisMaterials Actions

ActionRequired Permission(s)LinkDescription
CancelWS-ModifyChassisMaterialintegration/api/odata/ChassisMaterials({key})/Cancel
ActivateWS-ModifyChassisMaterialintegration/api/odata/ChassisMaterials({key})/ActivateFunction that will move a material in Active status.
DeactivateWS-ModifyChassisMaterialintegration/api/odata/ChassisMaterials({key})/DeactivateFunction that will move a material in Inactive status.
UploadFileWS-AddFileintegration/api/odata/ChassisMaterials({key})/UploadFile(File={file})
DeleteFileWS-ModifyFileintegration/api/odata/ChassisMaterials({key})/DeleteFile(FileName={filename})

ChassisMaterials Functions

FunctionRequired Permission(s)LinkDescription
SearchChassisByMaterialSlotsWS-ReadChassisintegration/api/odata/ChassisMaterials({key})/SearchChassisByMaterialSlots
DownloadFileWS-ReadFileintegration/api/odata/ChassisMaterials({key})/DownloadFile(FileName={filename})
GetAuditLogDataWS-ReadAuditLogintegration/api/odata/ChassisMaterials({key})/GetAuditLogDataFunction 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

CustomRouteRequired 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


CloudProviders Controller

Verb(s)Required Permission(s)LinkDescription
GETintegration/api/odata/CloudProviders
GETintegration/api/odata/CloudProviders({key})

CloudProviders Actions

No actions

CloudProviders Functions

No functions

CloudProviders Custom Routes

CustomRouteRequired 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


Connections Controller

Verb(s)Required Permission(s)LinkDescription
GETWS-ReadNetworkConnection,WS-ReadAssetToAssetMappingintegration/api/odata/Connections
GETWS-ReadNetworkConnection,WS-ReadAssetToAssetMappingintegration/api/odata/Connections({key})

Connections Actions

No actions

Connections Functions

No functions

Connections Custom Routes

No custom routes

Connections Nested Properties

No nested properties


CrossSectionalAreas Controller

Verb(s)Required Permission(s)LinkDescription
GETintegration/api/odata/CrossSectionalAreas
GETintegration/api/odata/CrossSectionalAreas({key})

CrossSectionalAreas Actions

No actions

CrossSectionalAreas Functions

No functions

CrossSectionalAreas Custom Routes

No custom routes

CrossSectionalAreas Nested Properties

No nested properties


Cultures Controller

Verb(s)Required Permission(s)LinkDescription
GETintegration/api/odata/Cultures
GETintegration/api/odata/Cultures({key})

Cultures Actions

No actions

Cultures Functions

No functions

Cultures Custom Routes

CustomRouteRequired 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


CustomFieldTypes Controller

Verb(s)Required Permission(s)LinkDescription
GETintegration/api/odata/CustomFieldTypes
GETintegration/api/odata/CustomFieldTypes({key})

CustomFieldTypes Actions

No actions

CustomFieldTypes Functions

No functions

CustomFieldTypes Custom Routes

CustomRouteRequired 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


ExclusionDates Controller

Verb(s)Required Permission(s)LinkDescription
DELETEWS-ModifyExclusionDateintegration/api/odata/ExclusionDates({key})
POSTWS-AddExclusionDateintegration/api/odata/ExclusionDates
POSTintegration/api/odata/ExclusionDates({key})
PATCHWS-ModifyExclusionDateintegration/api/odata/ExclusionDates({key})
GETintegration/api/odata/ExclusionDates
GETintegration/api/odata/ExclusionDates({key})

ExclusionDates Actions

No actions

ExclusionDates Functions

No functions

ExclusionDates Custom Routes

CustomRouteRequired 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


Floors Controller

Verb(s)Required Permission(s)LinkDescription
GETWS-ReadFloorPlanintegration/api/odata/Floors
POSTWS-ModifyFloorPlanintegration/api/odata/Floors
PUTWS-ModifyFloorPlanintegration/api/odata/Floors({key})
DELETEintegration/api/odata/Floors({key})
GETWS-ReadFloorPlanintegration/api/odata/Floors({key})

Floors Actions

No actions

Floors Functions

FunctionRequired Permission(s)LinkDescription
LoadFloorWS-ReadFloorPlanintegration/api/odata/Floors/LoadFloor(floorLocationGroupId={floorlocationgroupid})
GetLocationWeightWS-ReadFloorPlanintegration/api/odata/Floors({key})/GetLocationWeight

Floors Custom Routes

No custom routes

Floors Nested Properties

No nested properties


FlywheelGeneratorAuxiliaryMaterials Controller

Verb(s)Required Permission(s)LinkDescription
POSTWS-AddAuxiliaryMaterialintegration/api/odata/FlywheelGeneratorAuxiliaryMaterials
PATCHWS-ModifyAuxiliaryMaterialintegration/api/odata/FlywheelGeneratorAuxiliaryMaterials({key})
DELETEWS-ModifyAuxiliaryMaterialintegration/api/odata/FlywheelGeneratorAuxiliaryMaterials({key})
GETWS-ReadAuxiliaryMaterialintegration/api/odata/FlywheelGeneratorAuxiliaryMaterials
GETWS-ReadAuxiliaryMaterialintegration/api/odata/FlywheelGeneratorAuxiliaryMaterials({key})

FlywheelGeneratorAuxiliaryMaterials Actions

ActionRequired Permission(s)LinkDescription
CancelWS-ModifyAuxiliaryMaterialintegration/api/odata/FlywheelGeneratorAuxiliaryMaterials({key})/Cancel
ActivateWS-ModifyAuxiliaryMaterialintegration/api/odata/FlywheelGeneratorAuxiliaryMaterials({key})/ActivateFunction that will move a material in Active status.
DeactivateWS-ModifyAuxiliaryMaterialintegration/api/odata/FlywheelGeneratorAuxiliaryMaterials({key})/DeactivateFunction that will move a material in Inactive status.
UploadFileWS-AddFileintegration/api/odata/FlywheelGeneratorAuxiliaryMaterials({key})/UploadFile(File={file})
DeleteFileWS-ModifyFileintegration/api/odata/FlywheelGeneratorAuxiliaryMaterials({key})/DeleteFile(FileName={filename})

FlywheelGeneratorAuxiliaryMaterials Functions

FunctionRequired Permission(s)LinkDescription
DownloadFileWS-ReadFileintegration/api/odata/FlywheelGeneratorAuxiliaryMaterials({key})/DownloadFile(FileName={filename})
GetAuditLogDataWS-ReadAuditLogintegration/api/odata/FlywheelGeneratorAuxiliaryMaterials({key})/GetAuditLogDataFunction 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

CustomRouteRequired 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


FormBuilderMetaDataLists Controller

Verb(s)Required Permission(s)LinkDescription
GETintegration/api/odata/FormBuilderMetaDataLists
GETintegration/api/odata/FormBuilderMetaDataLists({key})

FormBuilderMetaDataLists Actions

No actions

FormBuilderMetaDataLists Functions

No functions

FormBuilderMetaDataLists Custom Routes

CustomRouteRequired 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


Forms Controller

Verb(s)Required Permission(s)LinkDescription
PUTWS-ModifyFormintegration/api/odata/Forms({key})
POSTWS-AddFormintegration/api/odata/Forms
POSTintegration/api/odata/Forms({key})
PATCHWS-ModifyFormintegration/api/odata/Forms({key})
GETWS-ReadFormintegration/api/odata/Forms
GETWS-ReadFormintegration/api/odata/Forms({key})

Forms Actions

ActionRequired Permission(s)LinkDescription
CopyWS-AddFormintegration/api/odata/Forms({key})/Copy(Name={name}, Description={description})
ImportWS-ReadFormintegration/api/odata/Forms/Import
SetStatusWS-ModifyFormintegration/api/odata/Forms({key})/SetStatus(Status={status})

Forms Functions

FunctionRequired Permission(s)LinkDescription
ExportWS-ReadFormintegration/api/odata/Forms({key})/Export
SqlViewsWS-ReadSqlViewintegration/api/odata/Forms/SqlViews
SqlViewValuesWS-ReadSqlViewintegration/api/odata/Forms/SqlViewValues(ViewName={viewname})

Forms Custom Routes

CustomRouteRequired 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


Graphs Controller

Verb(s)Required Permission(s)LinkDescription
GETWS-ReadAssetToAssetMappingintegration/api/odata/Graphs
GETWS-ReadAssetToAssetMappingintegration/api/odata/Graphs({key})

Graphs Actions

No actions

Graphs Functions

No functions

Graphs Custom Routes

No custom routes

Graphs Nested Properties

No nested properties


Groups Controller

Verb(s)Required Permission(s)LinkDescription
GETWS-ReadBusinessGroup,WS-ReadSupportGroupintegration/api/odata/Groups({key})
GETWS-ReadBusinessGroup,WS-ReadSupportGroupintegration/api/odata/Groups
GETWS-ReadBusinessGroup,WS-ReadSupportGroupintegration/api/odata/Groups({key})

Groups Actions

No actions

Groups Functions

No functions

Groups Custom Routes

No custom routes

Groups Nested Properties

No nested properties


IntegrationSystems Controller

Verb(s)Required Permission(s)LinkDescription
GETWS-ReadProcessintegration/api/odata/IntegrationSystems
GETWS-ReadProcessintegration/api/odata/IntegrationSystems({key})

IntegrationSystems Actions

No actions

IntegrationSystems Functions

No functions

IntegrationSystems Custom Routes

CustomRouteRequired 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


InternalEquipmentCategories Controller

Verb(s)Required Permission(s)LinkDescription
GETWS-ReadInternalEquipmentItemintegration/api/odata/InternalEquipmentCategories
GETWS-ReadInternalEquipmentItemintegration/api/odata/InternalEquipmentCategories({key})

InternalEquipmentCategories Actions

No actions

InternalEquipmentCategories Functions

No functions

InternalEquipmentCategories Custom Routes

CustomRouteRequired 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


InternalEquipmentItems Controller

Verb(s)Required Permission(s)LinkDescription
POSTWS-AddInternalEquipmentItemintegration/api/odata/InternalEquipmentItems
DELETEWS-ModifyInternalEquipmentItemintegration/api/odata/InternalEquipmentItems({key})
PATCHWS-ModifyInternalEquipmentItemintegration/api/odata/InternalEquipmentItems({key})
GETWS-ReadInternalEquipmentItemintegration/api/odata/InternalEquipmentItems
GETWS-ReadInternalEquipmentItemintegration/api/odata/InternalEquipmentItems({key})

InternalEquipmentItems Actions

No actions

InternalEquipmentItems Functions

No functions

InternalEquipmentItems Custom Routes

CustomRouteRequired 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


InternalEquipmentItemUtilisations Controller

Verb(s)Required Permission(s)LinkDescription
POSTWS-AddInternalEquipmentItemUtilisationintegration/api/odata/InternalEquipmentItemUtilisations
DELETEWS-ModifyInternalEquipmentItemUtilisationintegration/api/odata/InternalEquipmentItemUtilisations({key})
PATCHWS-ModifyInternalEquipmentItemUtilisationintegration/api/odata/InternalEquipmentItemUtilisations({key})
GETWS-ReadInternalEquipmentItemUtilisationintegration/api/odata/InternalEquipmentItemUtilisations
GETWS-ReadInternalEquipmentItemUtilisationintegration/api/odata/InternalEquipmentItemUtilisations({key})

InternalEquipmentItemUtilisations Actions

No actions

InternalEquipmentItemUtilisations Functions

No functions

InternalEquipmentItemUtilisations Custom Routes

No custom routes

InternalEquipmentItemUtilisations Nested Properties

No nested properties


IPAddresses Controller

Verb(s)Required Permission(s)LinkDescription
POSTintegration/api/odata/IPAddresses
PATCHintegration/api/odata/IPAddresses({key})
DELETEintegration/api/odata/IPAddresses({key})
GETintegration/api/odata/IPAddresses
GETintegration/api/odata/IPAddresses({key})

IPAddresses Actions

No actions

IPAddresses Functions

No functions

IPAddresses Custom Routes

CustomRouteRequired 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


KeyboardPeripheralMaterials Controller

Verb(s)Required Permission(s)LinkDescription
POSTWS-AddPeripheralMaterialintegration/api/odata/KeyboardPeripheralMaterials
PATCHWS-ModifyPeripheralMaterialintegration/api/odata/KeyboardPeripheralMaterials({key})
DELETEWS-ModifyPeripheralMaterialintegration/api/odata/KeyboardPeripheralMaterials({key})
GETWS-ReadPeripheralMaterialintegration/api/odata/KeyboardPeripheralMaterials
GETWS-ReadPeripheralMaterialintegration/api/odata/KeyboardPeripheralMaterials({key})

KeyboardPeripheralMaterials Actions

ActionRequired Permission(s)LinkDescription
CancelWS-ModifyPeripheralMaterialintegration/api/odata/KeyboardPeripheralMaterials({key})/Cancel
ActivateWS-ModifyPeripheralMaterialintegration/api/odata/KeyboardPeripheralMaterials({key})/ActivateFunction that will move a material in Active status.
DeactivateWS-ModifyPeripheralMaterialintegration/api/odata/KeyboardPeripheralMaterials({key})/DeactivateFunction that will move a material in Inactive status.
UploadFileWS-AddFileintegration/api/odata/KeyboardPeripheralMaterials({key})/UploadFile(File={file})
DeleteFileWS-ModifyFileintegration/api/odata/KeyboardPeripheralMaterials({key})/DeleteFile(FileName={filename})

KeyboardPeripheralMaterials Functions

FunctionRequired Permission(s)LinkDescription
DownloadFileWS-ReadFileintegration/api/odata/KeyboardPeripheralMaterials({key})/DownloadFile(FileName={filename})
GetAuditLogDataWS-ReadAuditLogintegration/api/odata/KeyboardPeripheralMaterials({key})/GetAuditLogDataFunction 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

CustomRouteRequired 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


KVMSwitches Controller

Verb(s)Required Permission(s)LinkDescription
POSTWS-ModifyKVMSwitchintegration/api/odata/KVMSwitches({key})
POSTWS-AddKVMSwitchintegration/api/odata/KVMSwitches
PATCHWS-ModifyKVMSwitchintegration/api/odata/KVMSwitches({key})
DELETEWS-ModifyKVMSwitchintegration/api/odata/KVMSwitches({key})
GETWS-ReadKVMSwitchintegration/api/odata/KVMSwitches
GETWS-ReadKVMSwitchintegration/api/odata/KVMSwitches({key})

KVMSwitches Actions

ActionRequired Permission(s)LinkDescription
BeginMoveWS-PlanMoveKVMSwitch, WS-PlanRecycleKVMSwitch, WS-PlanDecommissionKVMSwitchintegration/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.
CancelMoveWS-CancelMoveKVMSwitch, WS-CancelRecycleKVMSwitch, WS-CancelDecommissionKVMSwitchintegration/api/odata/KVMSwitches({key})/CancelMoveFunction that is used to cancel planned action. The selected asset will become Active/Operational.
CompleteMoveWS-CompleteMoveKVMSwitch, WS-CompleteRecycleKVMSwitch, WS-CompleteDecommissionKVMSwitchintegration/api/odata/KVMSwitches({key})/CompleteMoveFunction 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).
DirectMoveWS-SetLocationKVMSwitchintegration/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.
CompleteCreationWS-ModifyKVMSwitchintegration/api/odata/KVMSwitches({key})/CompleteCreationFunction that moves an asset from Planned/(Pre)Procurement to Active/Operational.
SetMaterialintegration/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.
AddRealTimeValuesWS-AddAssetRealtimeDataintegration/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.
AddNetworkAssetWS-ReadNetworkConnection,WS-AddNetworkConnectionintegration/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.
RemoveNetworkAssetWS-ModifyNetworkConnectionintegration/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.
UploadFileWS-AddFileintegration/api/odata/KVMSwitches({key})/UploadFile(File={file})
DeleteFileWS-ModifyFileintegration/api/odata/KVMSwitches({key})/DeleteFile(FileName={filename})

KVMSwitches Functions

FunctionRequired Permission(s)LinkDescription
ListLinkedRecordsintegration/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.
GetTotalSystemPowerConsumptionWS-ReadKVMSwitchintegration/api/odata/KVMSwitches({key})/GetTotalSystemPowerConsumptionFunction that returns the TotalSystemPowerConsumption for the selected asset.
GetRealTimePowerInfoWS-ReadKVMSwitchintegration/api/odata/KVMSwitches({key})/GetRealTimePowerInfo
GetDiscoveryAssetPageWS-ReadKVMSwitchintegration/api/odata/KVMSwitches({key})/GetDiscoveryAssetPageFunction that returns a collection of entities of type Nlyte.Model.AssetMapping. Used to determine external providers.
RecordModifiedInfoWS-ReadKVMSwitchintegration/api/odata/KVMSwitches({key})/RecordModifiedInfoFunction that returns an entity of type Nlyte.Model.AuditLogInfo and provides information regarding last modifications against the current asset
GetMountedChildAssetsintegration/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.
GetDistributorsWithFreeOutletsWS-ReadAssetToAssetMappingintegration/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.
SearchAssetNetworkPortLinkageWS-ReadNetworkConnectionintegration/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.
GetRealTimeValuesWS-ReadAssetRealtimeDataintegration/api/odata/KVMSwitches({key})/GetRealTimeValuesFunction that returns a collection of entities of type Nlyte.Model.RealTimeValue.
GetAssetSummariesintegration/api/odata/KVMSwitches({key})/GetAssetSummaries(OwnedPeripherals={ownedperipherals}, IncludeHosts={includehosts})
GetNetworkCardPortsInfoWS-ReadNetworkConnectionintegration/api/odata/KVMSwitches({key})/GetNetworkCardPortsInfoReturns an object of type Nlyte.Model.NetworkResults having information about Copper and Fiber Ports
GetNetworkCardPortConnectionsWS-ReadNetworkConnectionintegration/api/odata/KVMSwitches({key})/GetNetworkCardPortConnectionsReturns an object of type Nlyte.Model.NetworkResults having information about Copper and Fiber Port connections
GetNetworkAssetSummaryWS-ReadNetworkConnectionintegration/api/odata/KVMSwitches({key})/GetNetworkAssetSummaryReturns an object of type Nlyte.Model.NetworkResults having information about the networkable assets.
ListPowerConsumersintegration/api/odata/KVMSwitches({key})/ListPowerConsumersFunction that returns a collection of Nlyte.Model.Graph entities. Used to identify available Output Connector used in power connections.
SupportsPlannedMoveintegration/api/odata/KVMSwitches({key})/SupportsPlannedMove
GetTotalSystemWeightintegration/api/odata/KVMSwitches({key})/GetTotalSystemWeightFunction that returns the TotalSystemWeight for the selected asset.
GetMountedOnAssetIDintegration/api/odata/KVMSwitches({key})/GetMountedOnAssetID
GetAssetsReportDataWS-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-ReadServerHostintegration/api/odata/KVMSwitches/GetAssetsReportData(assetIds={assetids})
DownloadFileWS-ReadFileintegration/api/odata/KVMSwitches({key})/DownloadFile(FileName={filename})
GetAuditLogDataWS-ReadAuditLogintegration/api/odata/KVMSwitches({key})/GetAuditLogDataFunction 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

CustomRouteRequired 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})/CustomFieldsWS-ReadCustomFieldKVMSwitch GET
integration/api/odata/KVMSwitches({key})/CustomFieldsWS-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})/WarrantyWS-ReadKVMSwitch GET
integration/api/odata/KVMSwitches({key})/WarrantyWS-ModifyKVMSwitch POST
integration/api/odata/KVMSwitches({key})/WarrantyWS-ModifyKVMSwitch PATCH
integration/api/odata/KVMSwitches({key})/WarrantyWS-ModifyKVMSwitch DELETE
integration/api/odata/KVMSwitches({key})/MaintenanceWS-ReadKVMSwitch GET
integration/api/odata/KVMSwitches({key})/MaintenanceWS-ModifyKVMSwitch POST
integration/api/odata/KVMSwitches({key})/MaintenanceWS-ModifyKVMSwitch PATCH
integration/api/odata/KVMSwitches({key})/MaintenanceWS-ModifyKVMSwitch DELETE
integration/api/odata/KVMSwitches({key})/AssetMounting GET
integration/api/odata/KVMSwitches({key})/OwnershipWS-ReadBusinessGroupAssetMap GET
integration/api/odata/KVMSwitches({key})/Ownership({relatedKey})WS-ReadBusinessGroupAssetMap GET
integration/api/odata/KVMSwitches({key})/OwnershipWS-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})/SupportWS-ReadSupportGroupAssetMap GET
integration/api/odata/KVMSwitches({key})/Support({relatedKey})WS-ReadSupportGroupAssetMap GET
integration/api/odata/KVMSwitches({key})/SupportWS-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

NestedPropertySupported 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



KVMSwitchMaterials Controller

Verb(s)Required Permission(s)LinkDescription
POSTWS-ModifyKVMSwitchMaterialintegration/api/odata/KVMSwitchMaterials({key})
POSTWS-AddKVMSwitchMaterialintegration/api/odata/KVMSwitchMaterials
PATCHWS-ModifyKVMSwitchMaterialintegration/api/odata/KVMSwitchMaterials({key})
DELETEWS-ModifyKVMSwitchMaterialintegration/api/odata/KVMSwitchMaterials({key})
GETWS-ReadKVMSwitchMaterialintegration/api/odata/KVMSwitchMaterials
GETWS-ReadKVMSwitchMaterialintegration/api/odata/KVMSwitchMaterials({key})

KVMSwitchMaterials Actions

ActionRequired Permission(s)LinkDescription
CancelWS-ModifyKVMSwitchMaterialintegration/api/odata/KVMSwitchMaterials({key})/Cancel
ActivateWS-ModifyKVMSwitchMaterialintegration/api/odata/KVMSwitchMaterials({key})/ActivateFunction that will move a material in Active status.
DeactivateWS-ModifyKVMSwitchMaterialintegration/api/odata/KVMSwitchMaterials({key})/DeactivateFunction that will move a material in Inactive status.
UploadFileWS-AddFileintegration/api/odata/KVMSwitchMaterials({key})/UploadFile(File={file})
DeleteFileWS-ModifyFileintegration/api/odata/KVMSwitchMaterials({key})/DeleteFile(FileName={filename})

KVMSwitchMaterials Functions

FunctionRequired Permission(s)LinkDescription
DownloadFileWS-ReadFileintegration/api/odata/KVMSwitchMaterials({key})/DownloadFile(FileName={filename})
GetAuditLogDataWS-ReadAuditLogintegration/api/odata/KVMSwitchMaterials({key})/GetAuditLogDataFunction 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

CustomRouteRequired 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


LayerImages Controller

Verb(s)Required Permission(s)LinkDescription
GETintegration/api/odata/LayerImages({key})
GETintegration/api/odata/LayerImages
POSTintegration/api/odata/LayerImages
DELETEintegration/api/odata/LayerImages({key})
PATCHintegration/api/odata/LayerImages({key})
GETintegration/api/odata/LayerImages({key})

LayerImages Actions

ActionRequired Permission(s)LinkDescription
NormalizeImageWS-ModifyFloorPlanintegration/api/odata/LayerImages({key})/NormalizeImage

LayerImages Functions

No functions

LayerImages Custom Routes

CustomRouteRequired Permission(s)Supported Method(s)Description
integration/api/odata/CropFloorImagesToRoomLayersWS-ModifyFloorPlan POST

LayerImages Nested Properties

No nested properties


License Controller

Verb(s)Required Permission(s)LinkDescription
GETintegration/api/odata/License
GETintegration/api/odata/License({key})

License Actions

No actions

License Functions

No functions

License Custom Routes

No custom routes

License Nested Properties

No nested properties


ListTypes Controller

Verb(s)Required Permission(s)LinkDescription
GETintegration/api/odata/ListTypes
GETintegration/api/odata/ListTypes({key})

ListTypes Actions

No actions

ListTypes Functions

No functions

ListTypes Custom Routes

CustomRouteRequired 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


LocationGroups Controller

Verb(s)Required Permission(s)LinkDescription
DELETEintegration/api/odata/LocationGroups({key})
GETintegration/api/odata/LocationGroups
GETintegration/api/odata/LocationGroups({key})

LocationGroups Actions

No actions

LocationGroups Functions

FunctionRequired Permission(s)LinkDescription
Childrenintegration/api/odata/LocationGroups/Children(key={key})
Descendantsintegration/api/odata/LocationGroups/Descendants(key={key})

LocationGroups Custom Routes

CustomRouteRequired 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


LogicalPartitionTypes Controller

Verb(s)Required Permission(s)LinkDescription
GETintegration/api/odata/LogicalPartitionTypes
GETintegration/api/odata/LogicalPartitionTypes({key})

LogicalPartitionTypes Actions

No actions

LogicalPartitionTypes Functions

No functions

LogicalPartitionTypes Custom Routes

CustomRouteRequired 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


Manufacturers Controller

Verb(s)Required Permission(s)LinkDescription
GETintegration/api/odata/Manufacturers
GETintegration/api/odata/Manufacturers({key})

Manufacturers Actions

No actions

Manufacturers Functions

No functions

Manufacturers Custom Routes

CustomRouteRequired 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


MasterBreakers Controller

Verb(s)Required Permission(s)LinkDescription
GETWS-ReadPDUBreakerintegration/api/odata/MasterBreakers
GETWS-ReadPDUBreakerintegration/api/odata/MasterBreakers({key})

MasterBreakers Actions

No actions

MasterBreakers Functions

No functions

MasterBreakers Custom Routes

CustomRouteRequired 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


MaterialCategories Controller

Verb(s)Required Permission(s)LinkDescription
GETintegration/api/odata/MaterialCategories
GETintegration/api/odata/MaterialCategories({key})

MaterialCategories Actions

No actions

MaterialCategories Functions

No functions

MaterialCategories Custom Routes

CustomRouteRequired 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


MaterialImages Controller

Verb(s)Required Permission(s)LinkDescription
GETintegration/api/odata/MaterialImages
GETintegration/api/odata/MaterialImages({key})

MaterialImages Actions

No actions

MaterialImages Functions

No functions

MaterialImages Custom Routes

CustomRouteRequired 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


Materials Controller

Verb(s)Required Permission(s)LinkDescription
GETWS-ReadAirConditioningMaterial,WS-ReadAuxiliaryMaterial,WS-ReadCabinetMaterial,WS-ReadChassisMaterial,WS-ReadKVMSwitchMaterial,WS-ReadNetworkMaterial,WS-ReadPDUMaterial,WS-ReadPeripheralMaterial,WS-ReadPowerStripMaterial,WS-ReadReceptacleMaterial,WS-ReadServerMaterial,WS-ReadStaticSwitchMaterial,WS-ReadUPSMaterialintegration/api/odata/Materials
GETWS-ReadAirConditioningMaterial,WS-ReadAuxiliaryMaterial,WS-ReadCabinetMaterial,WS-ReadChassisMaterial,WS-ReadKVMSwitchMaterial,WS-ReadNetworkMaterial,WS-ReadPDUMaterial,WS-ReadPeripheralMaterial,WS-ReadPowerStripMaterial,WS-ReadReceptacleMaterial,WS-ReadServerMaterial,WS-ReadStaticSwitchMaterial,WS-ReadUPSMaterialintegration/api/odata/Materials({key})

Materials Actions

ActionRequired Permission(s)LinkDescription
UploadFileWS-AddFileintegration/api/odata/Materials({key})/UploadFile(File={file})
DeleteFileWS-ModifyFileintegration/api/odata/Materials({key})/DeleteFile(FileName={filename})

Materials Functions

FunctionRequired Permission(s)LinkDescription
DownloadFileWS-ReadFileintegration/api/odata/Materials({key})/DownloadFile(FileName={filename})

Materials Custom Routes

CustomRouteRequired 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


MaterialsAndSoftware Controller

Verb(s)Required Permission(s)LinkDescription
GETWS-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-ReadSoftwareintegration/api/odata/MaterialsAndSoftware
GETWS-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-ReadSoftwareintegration/api/odata/MaterialsAndSoftware({key})

MaterialsAndSoftware Actions

No actions

MaterialsAndSoftware Functions

No functions

MaterialsAndSoftware Custom Routes

CustomRouteRequired 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


MaterialSubtypes Controller

Verb(s)Required Permission(s)LinkDescription
GETintegration/api/odata/MaterialSubtypes
GETintegration/api/odata/MaterialSubtypes({key})

MaterialSubtypes Actions

No actions

MaterialSubtypes Functions

No functions

MaterialSubtypes Custom Routes

CustomRouteRequired 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


MaterialTypes Controller

Verb(s)Required Permission(s)LinkDescription
GETintegration/api/odata/MaterialTypes
GETintegration/api/odata/MaterialTypes({key})

MaterialTypes Actions

No actions

MaterialTypes Functions

No functions

MaterialTypes Custom Routes

CustomRouteRequired 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


ModuleNetworkMaterials Controller

Verb(s)Required Permission(s)LinkDescription
POSTWS-AddNetworkMaterialintegration/api/odata/ModuleNetworkMaterials
PATCHWS-ModifyNetworkMaterialintegration/api/odata/ModuleNetworkMaterials({key})
DELETEWS-ModifyNetworkMaterialintegration/api/odata/ModuleNetworkMaterials({key})
GETWS-ReadNetworkMaterialintegration/api/odata/ModuleNetworkMaterials
GETWS-ReadNetworkMaterialintegration/api/odata/ModuleNetworkMaterials({key})

ModuleNetworkMaterials Actions

ActionRequired Permission(s)LinkDescription
CancelWS-ModifyNetworkMaterialintegration/api/odata/ModuleNetworkMaterials({key})/Cancel
ActivateWS-ModifyNetworkMaterialintegration/api/odata/ModuleNetworkMaterials({key})/ActivateFunction that will move a material in Active status.
DeactivateWS-ModifyNetworkMaterialintegration/api/odata/ModuleNetworkMaterials({key})/DeactivateFunction that will move a material in Inactive status.
UploadFileWS-AddFileintegration/api/odata/ModuleNetworkMaterials({key})/UploadFile(File={file})
DeleteFileWS-ModifyFileintegration/api/odata/ModuleNetworkMaterials({key})/DeleteFile(FileName={filename})

ModuleNetworkMaterials Functions

FunctionRequired Permission(s)LinkDescription
DownloadFileWS-ReadFileintegration/api/odata/ModuleNetworkMaterials({key})/DownloadFile(FileName={filename})
GetAuditLogDataWS-ReadAuditLogintegration/api/odata/ModuleNetworkMaterials({key})/GetAuditLogDataFunction 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

CustomRouteRequired 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


MonitorPeripheralMaterials Controller

Verb(s)Required Permission(s)LinkDescription
POSTWS-ModifyPeripheralMaterialintegration/api/odata/MonitorPeripheralMaterials({key})
POSTWS-AddPeripheralMaterialintegration/api/odata/MonitorPeripheralMaterials
PATCHWS-ModifyPeripheralMaterialintegration/api/odata/MonitorPeripheralMaterials({key})
DELETEWS-ModifyPeripheralMaterialintegration/api/odata/MonitorPeripheralMaterials({key})
GETWS-ReadPeripheralMaterialintegration/api/odata/MonitorPeripheralMaterials
GETWS-ReadPeripheralMaterialintegration/api/odata/MonitorPeripheralMaterials({key})

MonitorPeripheralMaterials Actions

ActionRequired Permission(s)LinkDescription
CancelWS-ModifyPeripheralMaterialintegration/api/odata/MonitorPeripheralMaterials({key})/Cancel
ActivateWS-ModifyPeripheralMaterialintegration/api/odata/MonitorPeripheralMaterials({key})/ActivateFunction that will move a material in Active status.
DeactivateWS-ModifyPeripheralMaterialintegration/api/odata/MonitorPeripheralMaterials({key})/DeactivateFunction that will move a material in Inactive status.
UploadFileWS-AddFileintegration/api/odata/MonitorPeripheralMaterials({key})/UploadFile(File={file})
DeleteFileWS-ModifyFileintegration/api/odata/MonitorPeripheralMaterials({key})/DeleteFile(FileName={filename})

MonitorPeripheralMaterials Functions

FunctionRequired Permission(s)LinkDescription
DownloadFileWS-ReadFileintegration/api/odata/MonitorPeripheralMaterials({key})/DownloadFile(FileName={filename})
GetAuditLogDataWS-ReadAuditLogintegration/api/odata/MonitorPeripheralMaterials({key})/GetAuditLogDataFunction 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

CustomRouteRequired 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


MousePeripheralMaterials Controller

Verb(s)Required Permission(s)LinkDescription
POSTWS-AddPeripheralMaterialintegration/api/odata/MousePeripheralMaterials
PATCHWS-ModifyPeripheralMaterialintegration/api/odata/MousePeripheralMaterials({key})
DELETEWS-ModifyPeripheralMaterialintegration/api/odata/MousePeripheralMaterials({key})
GETWS-ReadPeripheralMaterialintegration/api/odata/MousePeripheralMaterials
GETWS-ReadPeripheralMaterialintegration/api/odata/MousePeripheralMaterials({key})

MousePeripheralMaterials Actions

ActionRequired Permission(s)LinkDescription
CancelWS-ModifyPeripheralMaterialintegration/api/odata/MousePeripheralMaterials({key})/Cancel
ActivateWS-ModifyPeripheralMaterialintegration/api/odata/MousePeripheralMaterials({key})/ActivateFunction that will move a material in Active status.
DeactivateWS-ModifyPeripheralMaterialintegration/api/odata/MousePeripheralMaterials({key})/DeactivateFunction that will move a material in Inactive status.
UploadFileWS-AddFileintegration/api/odata/MousePeripheralMaterials({key})/UploadFile(File={file})
DeleteFileWS-ModifyFileintegration/api/odata/MousePeripheralMaterials({key})/DeleteFile(FileName={filename})

MousePeripheralMaterials Functions

FunctionRequired Permission(s)LinkDescription
DownloadFileWS-ReadFileintegration/api/odata/MousePeripheralMaterials({key})/DownloadFile(FileName={filename})
GetAuditLogDataWS-ReadAuditLogintegration/api/odata/MousePeripheralMaterials({key})/GetAuditLogDataFunction 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

CustomRouteRequired 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


NavigatorAssets Controller

Verb(s)Required Permission(s)LinkDescription
GETWS-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-ReadChassisMountedAssetMapintegration/api/odata/NavigatorAssets({key})
GETWS-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-ReadChassisMountedAssetMapintegration/api/odata/NavigatorAssets

NavigatorAssets Actions

No actions

NavigatorAssets Functions

No functions

NavigatorAssets Custom Routes

CustomRouteRequired Permission(s)Supported Method(s)Description
integration/api/odata/NavigatorAssets/ByType(Ids={ids}, MaterialTypeID={materialTypeId}, IncludeChildren={includeChildren}) GET

NavigatorAssets Nested Properties

No nested properties


NetworkCableTypes Controller

Verb(s)Required Permission(s)LinkDescription
POSTintegration/api/odata/NetworkCableTypes
DELETEintegration/api/odata/NetworkCableTypes({key})
PATCHintegration/api/odata/NetworkCableTypes({key})
GETintegration/api/odata/NetworkCableTypes
GETintegration/api/odata/NetworkCableTypes({key})

NetworkCableTypes Actions

No actions

NetworkCableTypes Functions

No functions

NetworkCableTypes Custom Routes

No custom routes

NetworkCableTypes Nested Properties

No nested properties


NetworkCardPortNames Controller

Verb(s)Required Permission(s)LinkDescription
GETintegration/api/odata/NetworkCardPortNames
GETintegration/api/odata/NetworkCardPortNames({key})

NetworkCardPortNames Actions

No actions

NetworkCardPortNames Functions

No functions

NetworkCardPortNames Custom Routes

CustomRouteRequired 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


NetworkGraphs Controller

Verb(s)Required Permission(s)LinkDescription
POSTWS-ModifyNetworkConnectionintegration/api/odata/NetworkGraphs({key})
POSTWS-AddNetworkConnectionintegration/api/odata/NetworkGraphs
GETWS-ReadNetworkConnectionintegration/api/odata/NetworkGraphs
GETWS-ReadNetworkConnectionintegration/api/odata/NetworkGraphs({key})

NetworkGraphs Actions

No actions

NetworkGraphs Functions

No functions

NetworkGraphs Custom Routes

CustomRouteRequired 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/SetGroupTrunkNameWS-ModifyNetworkConnection POST

NetworkGraphs Nested Properties

NestedPropertySupported Method(s)
PortStartNode PATCH
PortEndNode PATCH



NetworkMaterials Controller

Verb(s)Required Permission(s)LinkDescription
POSTWS-ModifyNetworkMaterialintegration/api/odata/NetworkMaterials({key})
POSTWS-AddNetworkMaterialintegration/api/odata/NetworkMaterials
PATCHWS-ModifyNetworkMaterialintegration/api/odata/NetworkMaterials({key})
DELETEWS-ModifyNetworkMaterialintegration/api/odata/NetworkMaterials({key})
GETWS-ReadNetworkMaterialintegration/api/odata/NetworkMaterials
GETWS-ReadNetworkMaterialintegration/api/odata/NetworkMaterials({key})

NetworkMaterials Actions

ActionRequired Permission(s)LinkDescription
CancelWS-ModifyNetworkMaterialintegration/api/odata/NetworkMaterials({key})/Cancel
ActivateWS-ModifyNetworkMaterialintegration/api/odata/NetworkMaterials({key})/ActivateFunction that will move a material in Active status.
DeactivateWS-ModifyNetworkMaterialintegration/api/odata/NetworkMaterials({key})/DeactivateFunction that will move a material in Inactive status.
DeleteMaterialPortGroupMapsWS-ModifyNetworkMaterialintegration/api/odata/NetworkMaterials({key})/DeleteMaterialPortGroupMaps(NetworkMaterialPortGroupMapIDs={networkmaterialportgroupmapids})
UploadFileWS-AddFileintegration/api/odata/NetworkMaterials({key})/UploadFile(File={file})
DeleteFileWS-ModifyFileintegration/api/odata/NetworkMaterials({key})/DeleteFile(FileName={filename})

NetworkMaterials Functions

FunctionRequired Permission(s)LinkDescription
SearchNetworkByMaterialPortsWS-ReadNetworkintegration/api/odata/NetworkMaterials({key})/SearchNetworkByMaterialPorts
DownloadFileWS-ReadFileintegration/api/odata/NetworkMaterials({key})/DownloadFile(FileName={filename})
GetAuditLogDataWS-ReadAuditLogintegration/api/odata/NetworkMaterials({key})/GetAuditLogDataFunction 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

CustomRouteRequired 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


NetworkPortGroups Controller

Verb(s)Required Permission(s)LinkDescription
PATCHWS-ModifyNetworkConnectionintegration/api/odata/NetworkPortGroups({key})
POSTWS-ModifyNetworkConnectionintegration/api/odata/NetworkPortGroups({key})
GETWS-ReadNetworkConnectionintegration/api/odata/NetworkPortGroups
GETWS-ReadNetworkConnectionintegration/api/odata/NetworkPortGroups({key})

NetworkPortGroups Actions

No actions

NetworkPortGroups Functions

No functions

NetworkPortGroups Custom Routes

CustomRouteRequired Permission(s)Supported Method(s)Description
integration/api/odata/NetworkPortGroups({key})/NetworkPortGroupAssetIPAddressMaps DELETE

NetworkPortGroups Nested Properties

No nested properties


NetworkPortGroupTypes Controller

Verb(s)Required Permission(s)LinkDescription
GETWS-ReadNetworkConnectionintegration/api/odata/NetworkPortGroupTypes
GETWS-ReadNetworkConnectionintegration/api/odata/NetworkPortGroupTypes({key})

NetworkPortGroupTypes Actions

No actions

NetworkPortGroupTypes Functions

No functions

NetworkPortGroupTypes Custom Routes

No custom routes

NetworkPortGroupTypes Nested Properties

No nested properties


NetworkPorts Controller

Verb(s)Required Permission(s)LinkDescription
GETWS-ReadNetworkConnectionintegration/api/odata/NetworkPorts
GETWS-ReadNetworkConnectionintegration/api/odata/NetworkPorts({key})

NetworkPorts Actions

ActionRequired Permission(s)LinkDescription
GetPortConnectionTraceForExportWS-ReadNetworkConnectionintegration/api/odata/NetworkPorts({key})/GetPortConnectionTraceForExport

NetworkPorts Functions

FunctionRequired Permission(s)LinkDescription
GetPortConnectionTraceWS-ReadNetworkConnectionintegration/api/odata/NetworkPorts({key})/GetPortConnectionTrace
GetTraceLinksWS-ReadNetworkConnectionintegration/api/odata/NetworkPorts({key})/GetTraceLinks

NetworkPorts Custom Routes

CustomRouteRequired 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})/ServiceProviderWS-ModifyNetworkConnection PATCH
integration/api/odata/NetworkPorts/In(Ids={ids}) GET
integration/api/odata/NetworkPorts/NotIn(Ids={ids}) GET

NetworkPorts Nested Properties

NestedPropertySupported Method(s)
NetworkPortAssetIPAddressMaps POST
NetworkPortServerHostIPAddressMaps POST



Networks Controller

Verb(s)Required Permission(s)LinkDescription
POSTWS-AddNetworkintegration/api/odata/Networks
DELETEWS-ModifyNetworkintegration/api/odata/Networks({key})
PATCHWS-ModifyNetworkintegration/api/odata/Networks({key})
POSTWS-ModifyNetworkintegration/api/odata/Networks({key})
GETWS-ReadNetworkintegration/api/odata/Networks
GETWS-ReadNetworkintegration/api/odata/Networks({key})

Networks Actions

ActionRequired Permission(s)LinkDescription
BeginMoveWS-PlanMoveNetwork, WS-PlanRecycleNetwork, WS-PlanDecommissionNetworkintegration/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.
CancelMoveWS-CancelMoveNetwork, WS-CancelRecycleNetwork, WS-CancelDecommissionNetworkintegration/api/odata/Networks({key})/CancelMoveFunction that is used to cancel planned action. The selected asset will become Active/Operational.
CompleteMoveWS-CompleteMoveNetwork, WS-CompleteRecycleNetwork, WS-CompleteDecommissionNetworkintegration/api/odata/Networks({key})/CompleteMoveFunction 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).
DirectMoveWS-SetLocationNetworkintegration/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.
CompleteCreationWS-ModifyNetworkintegration/api/odata/Networks({key})/CompleteCreationFunction that moves an asset from Planned/(Pre)Procurement to Active/Operational.
SetMaterialintegration/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.
AddRealTimeValuesWS-AddAssetRealtimeDataintegration/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.
AddNetworkAssetWS-ReadNetworkConnection,WS-AddNetworkConnectionintegration/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.
RemoveNetworkAssetWS-ModifyNetworkConnectionintegration/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.
UploadFileWS-AddFileintegration/api/odata/Networks({key})/UploadFile(File={file})
DeleteFileWS-ModifyFileintegration/api/odata/Networks({key})/DeleteFile(FileName={filename})

Networks Functions

FunctionRequired Permission(s)LinkDescription
ListLinkedRecordsintegration/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.
GetCablePortConnectionsWS-ReadNetworkConnectionintegration/api/odata/Networks({key})/GetCablePortConnectionsReturns a collection of port connections for cable, entity type used is Nlyte.Model.NetworkResult
GetPatchPortConnectionsWS-ReadNetworkConnectionintegration/api/odata/Networks({key})/GetPatchPortConnectionsReturns a collection of port connections for patch, entity type used is Nlyte.Model.NetworkResult
GetTotalSystemPowerConsumptionWS-ReadNetworkintegration/api/odata/Networks({key})/GetTotalSystemPowerConsumptionFunction that returns the TotalSystemPowerConsumption for the selected asset.
GetRealTimePowerInfoWS-ReadNetworkintegration/api/odata/Networks({key})/GetRealTimePowerInfo
GetDiscoveryAssetPageWS-ReadNetworkintegration/api/odata/Networks({key})/GetDiscoveryAssetPageFunction that returns a collection of entities of type Nlyte.Model.AssetMapping. Used to determine external providers.
RecordModifiedInfoWS-ReadNetworkintegration/api/odata/Networks({key})/RecordModifiedInfoFunction that returns an entity of type Nlyte.Model.AuditLogInfo and provides information regarding last modifications against the current asset
GetChassisWithFreeSlotsWS-ReadChassisintegration/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.
GetMountedChildAssetsintegration/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.
GetDistributorsWithFreeOutletsWS-ReadAssetToAssetMappingintegration/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.
SearchAssetNetworkPortLinkageWS-ReadNetworkConnectionintegration/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.
GetRealTimeValuesWS-ReadAssetRealtimeDataintegration/api/odata/Networks({key})/GetRealTimeValuesFunction that returns a collection of entities of type Nlyte.Model.RealTimeValue.
GetAssetSummariesintegration/api/odata/Networks({key})/GetAssetSummaries(OwnedPeripherals={ownedperipherals}, IncludeHosts={includehosts})
GetNetworkCardPortsInfoWS-ReadNetworkConnectionintegration/api/odata/Networks({key})/GetNetworkCardPortsInfoReturns an object of type Nlyte.Model.NetworkResults having information about Copper and Fiber Ports
GetNetworkCardPortConnectionsWS-ReadNetworkConnectionintegration/api/odata/Networks({key})/GetNetworkCardPortConnectionsReturns an object of type Nlyte.Model.NetworkResults having information about Copper and Fiber Port connections
GetNetworkAssetSummaryWS-ReadNetworkConnectionintegration/api/odata/Networks({key})/GetNetworkAssetSummaryReturns an object of type Nlyte.Model.NetworkResults having information about the networkable assets.
ListPowerConsumersintegration/api/odata/Networks({key})/ListPowerConsumersFunction that returns a collection of Nlyte.Model.Graph entities. Used to identify available Output Connector used in power connections.
SupportsPlannedMoveintegration/api/odata/Networks({key})/SupportsPlannedMove
GetTotalSystemWeightintegration/api/odata/Networks({key})/GetTotalSystemWeightFunction that returns the TotalSystemWeight for the selected asset.
GetMountedOnAssetIDintegration/api/odata/Networks({key})/GetMountedOnAssetID
GetAssetsReportDataWS-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-ReadServerHostintegration/api/odata/Networks/GetAssetsReportData(assetIds={assetids})
DownloadFileWS-ReadFileintegration/api/odata/Networks({key})/DownloadFile(FileName={filename})
GetAuditLogDataWS-ReadAuditLogintegration/api/odata/Networks({key})/GetAuditLogDataFunction 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

CustomRouteRequired 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})/CustomFieldsWS-ReadCustomFieldNetwork GET
integration/api/odata/Networks({key})/CustomFieldsWS-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})/WarrantyWS-ReadNetwork GET
integration/api/odata/Networks({key})/WarrantyWS-ModifyNetwork POST
integration/api/odata/Networks({key})/WarrantyWS-ModifyNetwork PATCH
integration/api/odata/Networks({key})/WarrantyWS-ModifyNetwork DELETE
integration/api/odata/Networks({key})/MaintenanceWS-ReadNetwork GET
integration/api/odata/Networks({key})/MaintenanceWS-ModifyNetwork POST
integration/api/odata/Networks({key})/MaintenanceWS-ModifyNetwork PATCH
integration/api/odata/Networks({key})/MaintenanceWS-ModifyNetwork DELETE
integration/api/odata/Networks({key})/AssetMounting GET
integration/api/odata/Networks({key})/OwnershipWS-ReadBusinessGroupAssetMap GET
integration/api/odata/Networks({key})/Ownership({relatedKey})WS-ReadBusinessGroupAssetMap GET
integration/api/odata/Networks({key})/OwnershipWS-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})/SupportWS-ReadSupportGroupAssetMap GET
integration/api/odata/Networks({key})/Support({relatedKey})WS-ReadSupportGroupAssetMap GET
integration/api/odata/Networks({key})/SupportWS-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/BulkUpdateNetworkPortNamesWS-ModifyNetworkConnection POST

Networks Nested Properties

NestedPropertySupported 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



OutputConnectorRealTimeData Controller

Verb(s)Required Permission(s)LinkDescription
GETWS-ReadOutputConnectorRealtimeDataintegration/api/odata/OutputConnectorRealTimeData
GETWS-ReadOutputConnectorRealtimeDataintegration/api/odata/OutputConnectorRealTimeData({key})

OutputConnectorRealTimeData Actions

No actions

OutputConnectorRealTimeData Functions

No functions

OutputConnectorRealTimeData Custom Routes

CustomRouteRequired 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


OutputConnectorRealTimePhaseData Controller

Verb(s)Required Permission(s)LinkDescription
GETWS-ReadOutputConnectorRealtimePhaseDataintegration/api/odata/OutputConnectorRealTimePhaseData
GETWS-ReadOutputConnectorRealtimePhaseDataintegration/api/odata/OutputConnectorRealTimePhaseData({key})

OutputConnectorRealTimePhaseData Actions

No actions

OutputConnectorRealTimePhaseData Functions

No functions

OutputConnectorRealTimePhaseData Custom Routes

CustomRouteRequired 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


Overlays Controller

Verb(s)Required Permission(s)LinkDescription

Overlays Actions

No actions

Overlays Functions

FunctionRequired Permission(s)LinkDescription
GetColourSchemesintegration/api/odata/Overlays/GetColourSchemes
GetBusinessCriticalityLegendintegration/api/odata/Overlays/GetBusinessCriticalityLegend
GetFloorPlannerReportLegendintegration/api/odata/Overlays/GetFloorPlannerReportLegend(reportId={reportid})
GetCabinetPlannerReportLegendintegration/api/odata/Overlays/GetCabinetPlannerReportLegend(reportId={reportid})
GetFloorPlannerReportCodesintegration/api/odata/Overlays/GetFloorPlannerReportCodes
GetFloorPlannerCurrentReportCodesintegration/api/odata/Overlays/GetFloorPlannerCurrentReportCodes
GetFloorPlannerPlannedReportCodesintegration/api/odata/Overlays/GetFloorPlannerPlannedReportCodes
GetFloorPlannerReportWS-ReadRoomPlanintegration/api/odata/Overlays/GetFloorPlannerReport(reportId={reportid}, locationGroupId={locationgroupid}, schemeId={schemeid})
GetFloorPlannerReportForExportWS-ReadRoomPlanintegration/api/odata/Overlays/GetFloorPlannerReportForExport(reportId={reportid}, locationGroupId={locationgroupid})
GetCabinetPlannerReportintegration/api/odata/Overlays/GetCabinetPlannerReport(reportId={reportid}, cabinetIds={cabinetids}, schemeId={schemeid})
GetCabinetPlannerReportCodesintegration/api/odata/Overlays/GetCabinetPlannerReportCodes
GetCabinetPlannerReportForExportintegration/api/odata/Overlays/GetCabinetPlannerReportForExport(reportId={reportid}, cabinetIds={cabinetids})

Overlays Custom Routes

No custom routes

Overlays Nested Properties

No nested properties


PanelNetworkMaterials Controller

Verb(s)Required Permission(s)LinkDescription
POSTWS-AddNetworkMaterialintegration/api/odata/PanelNetworkMaterials
PATCHWS-ModifyNetworkMaterialintegration/api/odata/PanelNetworkMaterials({key})
DELETEWS-ModifyNetworkMaterialintegration/api/odata/PanelNetworkMaterials({key})
GETWS-ReadNetworkMaterialintegration/api/odata/PanelNetworkMaterials
GETWS-ReadNetworkMaterialintegration/api/odata/PanelNetworkMaterials({key})

PanelNetworkMaterials Actions

ActionRequired Permission(s)LinkDescription
CancelWS-ModifyNetworkMaterialintegration/api/odata/PanelNetworkMaterials({key})/Cancel
ActivateWS-ModifyNetworkMaterialintegration/api/odata/PanelNetworkMaterials({key})/ActivateFunction that will move a material in Active status.
DeactivateWS-ModifyNetworkMaterialintegration/api/odata/PanelNetworkMaterials({key})/DeactivateFunction that will move a material in Inactive status.
UploadFileWS-AddFileintegration/api/odata/PanelNetworkMaterials({key})/UploadFile(File={file})
DeleteFileWS-ModifyFileintegration/api/odata/PanelNetworkMaterials({key})/DeleteFile(FileName={filename})

PanelNetworkMaterials Functions

FunctionRequired Permission(s)LinkDescription
DownloadFileWS-ReadFileintegration/api/odata/PanelNetworkMaterials({key})/DownloadFile(FileName={filename})
GetAuditLogDataWS-ReadAuditLogintegration/api/odata/PanelNetworkMaterials({key})/GetAuditLogDataFunction 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

CustomRouteRequired 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


PDUMaterials Controller

Verb(s)Required Permission(s)LinkDescription
POSTWS-AddPDUMaterialintegration/api/odata/PDUMaterials
PATCHWS-ModifyPDUMaterialintegration/api/odata/PDUMaterials({key})
DELETEWS-ModifyPDUMaterialintegration/api/odata/PDUMaterials({key})
GETWS-ReadPDUMaterialintegration/api/odata/PDUMaterials
GETWS-ReadPDUMaterialintegration/api/odata/PDUMaterials({key})

PDUMaterials Actions

ActionRequired Permission(s)LinkDescription
CancelWS-ModifyPDUMaterialintegration/api/odata/PDUMaterials({key})/Cancel
ActivateWS-ModifyPDUMaterialintegration/api/odata/PDUMaterials({key})/ActivateFunction that will move a material in Active status.
DeactivateWS-ModifyPDUMaterialintegration/api/odata/PDUMaterials({key})/DeactivateFunction that will move a material in Inactive status.
UploadFileWS-AddFileintegration/api/odata/PDUMaterials({key})/UploadFile(File={file})
DeleteFileWS-ModifyFileintegration/api/odata/PDUMaterials({key})/DeleteFile(FileName={filename})

PDUMaterials Functions

FunctionRequired Permission(s)LinkDescription
DownloadFileWS-ReadFileintegration/api/odata/PDUMaterials({key})/DownloadFile(FileName={filename})
GetAuditLogDataWS-ReadAuditLogintegration/api/odata/PDUMaterials({key})/GetAuditLogDataFunction 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

CustomRouteRequired 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


PDUs Controller

Verb(s)Required Permission(s)LinkDescription
POSTWS-ModifyPDUintegration/api/odata/PDUs({key})
POSTWS-AddPDUintegration/api/odata/PDUs
PATCHWS-ModifyPDUintegration/api/odata/PDUs({key})
DELETEWS-ModifyPDUintegration/api/odata/PDUs({key})
GETWS-ReadPDUintegration/api/odata/PDUs
GETWS-ReadPDUintegration/api/odata/PDUs({key})

PDUs Actions

ActionRequired Permission(s)LinkDescription
BeginMoveWS-PlanRecyclePDU, WS-PlanDecommissionPDUintegration/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.
CancelMoveWS-CancelRecyclePDU, WS-CancelDecommissionPDUintegration/api/odata/PDUs({key})/CancelMoveFunction that is used to cancel planned action. The selected asset will become Active/Operational.
CompleteMoveWS-CompleteRecyclePDU, WS-CompleteDecommissionPDUintegration/api/odata/PDUs({key})/CompleteMoveFunction 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).
DirectMoveWS-SetLocationPDUintegration/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.
CompleteCreationWS-ModifyPDUintegration/api/odata/PDUs({key})/CompleteCreationFunction that moves an asset from Planned/(Pre)Procurement to Active/Operational.
SetMaterialintegration/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.
AddRealTimeValuesWS-AddAssetRealtimeDataintegration/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.
AddNetworkAssetWS-ReadNetworkConnection,WS-AddNetworkConnectionintegration/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.
RemoveNetworkAssetWS-ModifyNetworkConnectionintegration/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.
UploadFileWS-AddFileintegration/api/odata/PDUs({key})/UploadFile(File={file})
DeleteFileWS-ModifyFileintegration/api/odata/PDUs({key})/DeleteFile(FileName={filename})

PDUs Functions

FunctionRequired Permission(s)LinkDescription
GetTotalSystemPowerConsumptionWS-ReadPDUintegration/api/odata/PDUs({key})/GetTotalSystemPowerConsumptionFunction that returns the TotalSystemPowerConsumption for the selected asset.
GetRealTimePowerInfoWS-ReadPDUintegration/api/odata/PDUs({key})/GetRealTimePowerInfo
GetDiscoveryAssetPageWS-ReadPDUintegration/api/odata/PDUs({key})/GetDiscoveryAssetPageFunction that returns a collection of entities of type Nlyte.Model.AssetMapping. Used to determine external providers.
RecordModifiedInfoWS-ReadPDUintegration/api/odata/PDUs({key})/RecordModifiedInfoFunction that returns an entity of type Nlyte.Model.AuditLogInfo and provides information regarding last modifications against the current asset
GetMountedChildAssetsintegration/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.
GetDistributorsWithFreeOutletsWS-ReadAssetToAssetMappingintegration/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.
SearchAssetNetworkPortLinkageWS-ReadNetworkConnectionintegration/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.
GetRealTimeValuesWS-ReadAssetRealtimeDataintegration/api/odata/PDUs({key})/GetRealTimeValuesFunction that returns a collection of entities of type Nlyte.Model.RealTimeValue.
GetAssetSummariesintegration/api/odata/PDUs({key})/GetAssetSummaries(OwnedPeripherals={ownedperipherals}, IncludeHosts={includehosts})
GetNetworkCardPortsInfoWS-ReadNetworkConnectionintegration/api/odata/PDUs({key})/GetNetworkCardPortsInfoReturns an object of type Nlyte.Model.NetworkResults having information about Copper and Fiber Ports
GetNetworkCardPortConnectionsWS-ReadNetworkConnectionintegration/api/odata/PDUs({key})/GetNetworkCardPortConnectionsReturns an object of type Nlyte.Model.NetworkResults having information about Copper and Fiber Port connections
GetNetworkAssetSummaryWS-ReadNetworkConnectionintegration/api/odata/PDUs({key})/GetNetworkAssetSummaryReturns an object of type Nlyte.Model.NetworkResults having information about the networkable assets.
ListPowerConsumersintegration/api/odata/PDUs({key})/ListPowerConsumersFunction that returns a collection of Nlyte.Model.Graph entities. Used to identify available Output Connector used in power connections.
SupportsPlannedMoveintegration/api/odata/PDUs({key})/SupportsPlannedMove
GetTotalSystemWeightintegration/api/odata/PDUs({key})/GetTotalSystemWeightFunction that returns the TotalSystemWeight for the selected asset.
GetMountedOnAssetIDintegration/api/odata/PDUs({key})/GetMountedOnAssetID
GetAssetsReportDataWS-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-ReadServerHostintegration/api/odata/PDUs/GetAssetsReportData(assetIds={assetids})
DownloadFileWS-ReadFileintegration/api/odata/PDUs({key})/DownloadFile(FileName={filename})
GetAuditLogDataWS-ReadAuditLogintegration/api/odata/PDUs({key})/GetAuditLogDataFunction 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

CustomRouteRequired 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})/CustomFieldsWS-ReadCustomFieldPDU GET
integration/api/odata/PDUs({key})/CustomFieldsWS-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})/WarrantyWS-ReadPDU GET
integration/api/odata/PDUs({key})/WarrantyWS-ModifyPDU POST
integration/api/odata/PDUs({key})/WarrantyWS-ModifyPDU PATCH
integration/api/odata/PDUs({key})/WarrantyWS-ModifyPDU DELETE
integration/api/odata/PDUs({key})/MaintenanceWS-ReadPDU GET
integration/api/odata/PDUs({key})/MaintenanceWS-ModifyPDU POST
integration/api/odata/PDUs({key})/MaintenanceWS-ModifyPDU PATCH
integration/api/odata/PDUs({key})/MaintenanceWS-ModifyPDU DELETE
integration/api/odata/PDUs({key})/AssetMounting GET
integration/api/odata/PDUs({key})/OwnershipWS-ReadBusinessGroupAssetMap GET
integration/api/odata/PDUs({key})/Ownership({relatedKey})WS-ReadBusinessGroupAssetMap GET
integration/api/odata/PDUs({key})/OwnershipWS-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})/SupportWS-ReadSupportGroupAssetMap GET
integration/api/odata/PDUs({key})/Support({relatedKey})WS-ReadSupportGroupAssetMap GET
integration/api/odata/PDUs({key})/SupportWS-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

NestedPropertySupported 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



PeripheralMaterials Controller

Verb(s)Required Permission(s)LinkDescription
POSTWS-AddPeripheralMaterialintegration/api/odata/PeripheralMaterials
PATCHWS-ModifyPeripheralMaterialintegration/api/odata/PeripheralMaterials({key})
DELETEWS-ModifyPeripheralMaterialintegration/api/odata/PeripheralMaterials({key})
GETWS-ReadPeripheralMaterialintegration/api/odata/PeripheralMaterials
GETWS-ReadPeripheralMaterialintegration/api/odata/PeripheralMaterials({key})

PeripheralMaterials Actions

ActionRequired Permission(s)LinkDescription
CancelWS-ModifyPeripheralMaterialintegration/api/odata/PeripheralMaterials({key})/Cancel
ActivateWS-ModifyPeripheralMaterialintegration/api/odata/PeripheralMaterials({key})/ActivateFunction that will move a material in Active status.
DeactivateWS-ModifyPeripheralMaterialintegration/api/odata/PeripheralMaterials({key})/DeactivateFunction that will move a material in Inactive status.
UploadFileWS-AddFileintegration/api/odata/PeripheralMaterials({key})/UploadFile(File={file})
DeleteFileWS-ModifyFileintegration/api/odata/PeripheralMaterials({key})/DeleteFile(FileName={filename})

PeripheralMaterials Functions

FunctionRequired Permission(s)LinkDescription
DownloadFileWS-ReadFileintegration/api/odata/PeripheralMaterials({key})/DownloadFile(FileName={filename})
GetAuditLogDataWS-ReadAuditLogintegration/api/odata/PeripheralMaterials({key})/GetAuditLogDataFunction 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

CustomRouteRequired 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


Peripherals Controller

Verb(s)Required Permission(s)LinkDescription
POSTWS-ModifyPeripheralintegration/api/odata/Peripherals({key})
PATCHWS-ModifyPeripheralintegration/api/odata/Peripherals({key})
POSTWS-AddPeripheralintegration/api/odata/Peripherals
DELETEWS-ModifyPeripheralintegration/api/odata/Peripherals({key})
GETWS-ReadPeripheralintegration/api/odata/Peripherals
GETWS-ReadPeripheralintegration/api/odata/Peripherals({key})

Peripherals Actions

ActionRequired Permission(s)LinkDescription
BeginMoveWS-PlanMovePeripheral, WS-PlanRecyclePeripheral, WS-PlanDecommissionPeripheralintegration/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.
CancelMoveWS-CancelMovePeripheral, WS-CancelRecyclePeripheral, WS-CancelDecommissionPeripheralintegration/api/odata/Peripherals({key})/CancelMoveFunction that is used to cancel planned action. The selected asset will become Active/Operational.
CompleteMoveWS-CompleteMovePeripheral, WS-CompleteRecyclePeripheral, WS-CompleteDecommissionPeripheralintegration/api/odata/Peripherals({key})/CompleteMoveFunction 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).
DirectMoveWS-SetLocationPeripheralintegration/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.
CompleteCreationWS-ModifyPeripheralintegration/api/odata/Peripherals({key})/CompleteCreationFunction that moves an asset from Planned/(Pre)Procurement to Active/Operational.
SetMaterialintegration/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.
AddRealTimeValuesWS-AddAssetRealtimeDataintegration/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.
AddNetworkAssetWS-ReadNetworkConnection,WS-AddNetworkConnectionintegration/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.
RemoveNetworkAssetWS-ModifyNetworkConnectionintegration/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.
UploadFileWS-AddFileintegration/api/odata/Peripherals({key})/UploadFile(File={file})
DeleteFileWS-ModifyFileintegration/api/odata/Peripherals({key})/DeleteFile(FileName={filename})

Peripherals Functions

FunctionRequired Permission(s)LinkDescription
GetTotalSystemPowerConsumptionWS-ReadPeripheralintegration/api/odata/Peripherals({key})/GetTotalSystemPowerConsumptionFunction that returns the TotalSystemPowerConsumption for the selected asset.
GetRealTimePowerInfoWS-ReadPeripheralintegration/api/odata/Peripherals({key})/GetRealTimePowerInfo
GetDiscoveryAssetPageWS-ReadPeripheralintegration/api/odata/Peripherals({key})/GetDiscoveryAssetPageFunction that returns a collection of entities of type Nlyte.Model.AssetMapping. Used to determine external providers.
RecordModifiedInfoWS-ReadPeripheralintegration/api/odata/Peripherals({key})/RecordModifiedInfoFunction that returns an entity of type Nlyte.Model.AuditLogInfo and provides information regarding last modifications against the current asset
GetMountedChildAssetsintegration/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.
GetDistributorsWithFreeOutletsWS-ReadAssetToAssetMappingintegration/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.
SearchAssetNetworkPortLinkageWS-ReadNetworkConnectionintegration/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.
GetRealTimeValuesWS-ReadAssetRealtimeDataintegration/api/odata/Peripherals({key})/GetRealTimeValuesFunction that returns a collection of entities of type Nlyte.Model.RealTimeValue.
GetAssetSummariesintegration/api/odata/Peripherals({key})/GetAssetSummaries(OwnedPeripherals={ownedperipherals}, IncludeHosts={includehosts})
GetNetworkCardPortsInfoWS-ReadNetworkConnectionintegration/api/odata/Peripherals({key})/GetNetworkCardPortsInfoReturns an object of type Nlyte.Model.NetworkResults having information about Copper and Fiber Ports
GetNetworkCardPortConnectionsWS-ReadNetworkConnectionintegration/api/odata/Peripherals({key})/GetNetworkCardPortConnectionsReturns an object of type Nlyte.Model.NetworkResults having information about Copper and Fiber Port connections
GetNetworkAssetSummaryWS-ReadNetworkConnectionintegration/api/odata/Peripherals({key})/GetNetworkAssetSummaryReturns an object of type Nlyte.Model.NetworkResults having information about the networkable assets.
ListPowerConsumersintegration/api/odata/Peripherals({key})/ListPowerConsumersFunction that returns a collection of Nlyte.Model.Graph entities. Used to identify available Output Connector used in power connections.
SupportsPlannedMoveintegration/api/odata/Peripherals({key})/SupportsPlannedMove
GetTotalSystemWeightintegration/api/odata/Peripherals({key})/GetTotalSystemWeightFunction that returns the TotalSystemWeight for the selected asset.
GetMountedOnAssetIDintegration/api/odata/Peripherals({key})/GetMountedOnAssetID
GetAssetsReportDataWS-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-ReadServerHostintegration/api/odata/Peripherals/GetAssetsReportData(assetIds={assetids})
DownloadFileWS-ReadFileintegration/api/odata/Peripherals({key})/DownloadFile(FileName={filename})
GetAuditLogDataWS-ReadAuditLogintegration/api/odata/Peripherals({key})/GetAuditLogDataFunction 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

CustomRouteRequired 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})/CustomFieldsWS-ReadCustomFieldPeripheral GET
integration/api/odata/Peripherals({key})/ConnectedAssets POST
integration/api/odata/Peripherals({key})/CustomFieldsWS-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})/WarrantyWS-ReadPeripheral GET
integration/api/odata/Peripherals({key})/WarrantyWS-ModifyPeripheral POST
integration/api/odata/Peripherals({key})/WarrantyWS-ModifyPeripheral PATCH
integration/api/odata/Peripherals({key})/WarrantyWS-ModifyPeripheral DELETE
integration/api/odata/Peripherals({key})/MaintenanceWS-ReadPeripheral GET
integration/api/odata/Peripherals({key})/MaintenanceWS-ModifyPeripheral POST
integration/api/odata/Peripherals({key})/MaintenanceWS-ModifyPeripheral PATCH
integration/api/odata/Peripherals({key})/MaintenanceWS-ModifyPeripheral DELETE
integration/api/odata/Peripherals({key})/AssetMounting GET
integration/api/odata/Peripherals({key})/OwnershipWS-ReadBusinessGroupAssetMap GET
integration/api/odata/Peripherals({key})/Ownership({relatedKey})WS-ReadBusinessGroupAssetMap GET
integration/api/odata/Peripherals({key})/OwnershipWS-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})/SupportWS-ReadSupportGroupAssetMap GET
integration/api/odata/Peripherals({key})/Support({relatedKey})WS-ReadSupportGroupAssetMap GET
integration/api/odata/Peripherals({key})/SupportWS-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

NestedPropertySupported 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



Permissions Controller

Verb(s)Required Permission(s)LinkDescription
GETintegration/api/odata/Permissions
GETintegration/api/odata/Permissions({key})

Permissions Actions

No actions

Permissions Functions

No functions

Permissions Custom Routes

CustomRouteRequired 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


PollTypes Controller

Verb(s)Required Permission(s)LinkDescription
GETintegration/api/odata/PollTypes
GETintegration/api/odata/PollTypes({key})

PollTypes Actions

No actions

PollTypes Functions

No functions

PollTypes Custom Routes

CustomRouteRequired 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


PowerStripMaterials Controller

Verb(s)Required Permission(s)LinkDescription
POSTWS-ModifyPowerStripMaterialintegration/api/odata/PowerStripMaterials({key})
POSTWS-AddPowerStripMaterialintegration/api/odata/PowerStripMaterials
PATCHWS-ModifyPowerStripMaterialintegration/api/odata/PowerStripMaterials({key})
DELETEWS-ModifyPowerStripMaterialintegration/api/odata/PowerStripMaterials({key})
GETWS-ReadPowerStripMaterialintegration/api/odata/PowerStripMaterials
GETWS-ReadPowerStripMaterialintegration/api/odata/PowerStripMaterials({key})

PowerStripMaterials Actions

ActionRequired Permission(s)LinkDescription
CancelWS-ModifyPowerStripMaterialintegration/api/odata/PowerStripMaterials({key})/Cancel
ActivateWS-ModifyPowerStripMaterialintegration/api/odata/PowerStripMaterials({key})/ActivateFunction that will move a material in Active status.
DeactivateWS-ModifyPowerStripMaterialintegration/api/odata/PowerStripMaterials({key})/DeactivateFunction that will move a material in Inactive status.
UploadFileWS-AddFileintegration/api/odata/PowerStripMaterials({key})/UploadFile(File={file})
DeleteFileWS-ModifyFileintegration/api/odata/PowerStripMaterials({key})/DeleteFile(FileName={filename})

PowerStripMaterials Functions

FunctionRequired Permission(s)LinkDescription
DownloadFileWS-ReadFileintegration/api/odata/PowerStripMaterials({key})/DownloadFile(FileName={filename})
GetAuditLogDataWS-ReadAuditLogintegration/api/odata/PowerStripMaterials({key})/GetAuditLogDataFunction 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

CustomRouteRequired 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


PowerStrips Controller

Verb(s)Required Permission(s)LinkDescription
POSTWS-ModifyPowerStripintegration/api/odata/PowerStrips({key})
POSTWS-AddPowerStripintegration/api/odata/PowerStrips
PATCHWS-ModifyPowerStripintegration/api/odata/PowerStrips({key})
DELETEWS-ModifyPowerStripintegration/api/odata/PowerStrips({key})
GETWS-ReadPowerStripintegration/api/odata/PowerStrips
GETWS-ReadPowerStripintegration/api/odata/PowerStrips({key})

PowerStrips Actions

ActionRequired Permission(s)LinkDescription
SetMaterialWS-SetMaterialPowerStripintegration/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.
BeginMoveWS-PlanDecommissionPowerStripintegration/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.
CancelMoveWS-CancelDecommissionPowerStripintegration/api/odata/PowerStrips({key})/CancelMoveFunction that is used to cancel planned action. The selected asset will become Active/Operational.
CompleteMoveWS-CompleteDecommissionPowerStripintegration/api/odata/PowerStrips({key})/CompleteMoveFunction 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).
DirectMoveWS-SetLocationPowerStripintegration/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.
CompleteCreationWS-ModifyPowerStripintegration/api/odata/PowerStrips({key})/CompleteCreationFunction that moves an asset from Planned/(Pre)Procurement to Active/Operational.
AddRealTimeValuesWS-AddAssetRealtimeDataintegration/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.
AddNetworkAssetWS-ReadNetworkConnection,WS-AddNetworkConnectionintegration/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.
RemoveNetworkAssetWS-ModifyNetworkConnectionintegration/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.
UploadFileWS-AddFileintegration/api/odata/PowerStrips({key})/UploadFile(File={file})
DeleteFileWS-ModifyFileintegration/api/odata/PowerStrips({key})/DeleteFile(FileName={filename})

PowerStrips Functions

FunctionRequired Permission(s)LinkDescription
GetTotalSystemPowerConsumptionWS-ReadPowerStripintegration/api/odata/PowerStrips({key})/GetTotalSystemPowerConsumptionFunction that returns the TotalSystemPowerConsumption for the selected asset.
GetRealTimePowerInfoWS-ReadPowerStripintegration/api/odata/PowerStrips({key})/GetRealTimePowerInfo
GetDiscoveryAssetPageWS-ReadPowerStripintegration/api/odata/PowerStrips({key})/GetDiscoveryAssetPageFunction that returns a collection of entities of type Nlyte.Model.AssetMapping. Used to determine external providers.
RecordModifiedInfoWS-ReadPowerStripintegration/api/odata/PowerStrips({key})/RecordModifiedInfoFunction that returns an entity of type Nlyte.Model.AuditLogInfo and provides information regarding last modifications against the current asset
GetMountedChildAssetsintegration/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.
GetDistributorsWithFreeOutletsWS-ReadAssetToAssetMappingintegration/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.
SearchAssetNetworkPortLinkageWS-ReadNetworkConnectionintegration/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.
GetRealTimeValuesWS-ReadAssetRealtimeDataintegration/api/odata/PowerStrips({key})/GetRealTimeValuesFunction that returns a collection of entities of type Nlyte.Model.RealTimeValue.
GetAssetSummariesintegration/api/odata/PowerStrips({key})/GetAssetSummaries(OwnedPeripherals={ownedperipherals}, IncludeHosts={includehosts})
GetNetworkCardPortsInfoWS-ReadNetworkConnectionintegration/api/odata/PowerStrips({key})/GetNetworkCardPortsInfoReturns an object of type Nlyte.Model.NetworkResults having information about Copper and Fiber Ports
GetNetworkCardPortConnectionsWS-ReadNetworkConnectionintegration/api/odata/PowerStrips({key})/GetNetworkCardPortConnectionsReturns an object of type Nlyte.Model.NetworkResults having information about Copper and Fiber Port connections
GetNetworkAssetSummaryWS-ReadNetworkConnectionintegration/api/odata/PowerStrips({key})/GetNetworkAssetSummaryReturns an object of type Nlyte.Model.NetworkResults having information about the networkable assets.
ListPowerConsumersintegration/api/odata/PowerStrips({key})/ListPowerConsumersFunction that returns a collection of Nlyte.Model.Graph entities. Used to identify available Output Connector used in power connections.
SupportsPlannedMoveintegration/api/odata/PowerStrips({key})/SupportsPlannedMove
GetTotalSystemWeightintegration/api/odata/PowerStrips({key})/GetTotalSystemWeightFunction that returns the TotalSystemWeight for the selected asset.
GetMountedOnAssetIDintegration/api/odata/PowerStrips({key})/GetMountedOnAssetID
GetAssetsReportDataWS-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-ReadServerHostintegration/api/odata/PowerStrips/GetAssetsReportData(assetIds={assetids})
DownloadFileWS-ReadFileintegration/api/odata/PowerStrips({key})/DownloadFile(FileName={filename})
GetAuditLogDataWS-ReadAuditLogintegration/api/odata/PowerStrips({key})/GetAuditLogDataFunction 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

CustomRouteRequired 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})/CustomFieldsWS-ReadCustomFieldPowerStrip GET
integration/api/odata/PowerStrips({key})/CustomFieldsWS-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})/WarrantyWS-ReadPowerStrip GET
integration/api/odata/PowerStrips({key})/WarrantyWS-ModifyPowerStrip POST
integration/api/odata/PowerStrips({key})/WarrantyWS-ModifyPowerStrip PATCH
integration/api/odata/PowerStrips({key})/WarrantyWS-ModifyPowerStrip DELETE
integration/api/odata/PowerStrips({key})/MaintenanceWS-ReadPowerStrip GET
integration/api/odata/PowerStrips({key})/MaintenanceWS-ModifyPowerStrip POST
integration/api/odata/PowerStrips({key})/MaintenanceWS-ModifyPowerStrip PATCH
integration/api/odata/PowerStrips({key})/MaintenanceWS-ModifyPowerStrip DELETE
integration/api/odata/PowerStrips({key})/AssetMounting GET
integration/api/odata/PowerStrips({key})/OwnershipWS-ReadBusinessGroupAssetMap GET
integration/api/odata/PowerStrips({key})/Ownership({relatedKey})WS-ReadBusinessGroupAssetMap GET
integration/api/odata/PowerStrips({key})/OwnershipWS-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})/SupportWS-ReadSupportGroupAssetMap GET
integration/api/odata/PowerStrips({key})/Support({relatedKey})WS-ReadSupportGroupAssetMap GET
integration/api/odata/PowerStrips({key})/SupportWS-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

NestedPropertySupported 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



Processes Controller

Verb(s)Required Permission(s)LinkDescription
PUTWS-ModifyProcessintegration/api/odata/Processes({key})
POSTWS-AddProcessintegration/api/odata/Processes
POSTintegration/api/odata/Processes({key})
PATCHWS-ModifyProcessintegration/api/odata/Processes({key})
GETWS-ReadProcessintegration/api/odata/Processes
GETWS-ReadProcessintegration/api/odata/Processes({key})

Processes Actions

ActionRequired Permission(s)LinkDescription
CopyWS-AddProcessintegration/api/odata/Processes({key})/Copy(Name={name}, Description={description})
CalculateDurationintegration/api/odata/Processes/CalculateDuration(process={process})
SetStatusWS-ModifyProcessintegration/api/odata/Processes({key})/SetStatus(Status={status})
ImportWS-ReadProcess, WS-AddFormintegration/api/odata/Processes/Import
ReplaceFormWS-ModifyProcessintegration/api/odata/Processes/ReplaceForm(oldFormID={oldformid}, newFormID={newformid}, process={process})
AddLocationsWS-ModifyProcessintegration/api/odata/Processes({key})/AddLocations(locationIds={locationids}, selectedLocationId={selectedlocationid})
RemoveLocationsWS-ModifyProcessintegration/api/odata/Processes({key})/RemoveLocations(locationIds={locationids}, selectedLocationId={selectedlocationid})

Processes Functions

FunctionRequired Permission(s)LinkDescription
ExportWS-ReadProcessintegration/api/odata/Processes({key})/Export

Processes Custom Routes

CustomRouteRequired 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


ProjectDependencies Controller

Verb(s)Required Permission(s)LinkDescription
POSTintegration/api/odata/ProjectDependencies
PATCHintegration/api/odata/ProjectDependencies({key})
DELETEintegration/api/odata/ProjectDependencies({key})
GETintegration/api/odata/ProjectDependencies
GETintegration/api/odata/ProjectDependencies({key})

ProjectDependencies Actions

No actions

ProjectDependencies Functions

No functions

ProjectDependencies Custom Routes

CustomRouteRequired 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


ProjectItemAllocateCriterias Controller

Verb(s)Required Permission(s)LinkDescription
GETWS-ReadCabinet,WS-ReadChassis,WS-ReadServer,WS-ReadNetwork,WS-ReadPeripheral,WS-ReadServerHost,WS-ReadNetworkMaterial,WS-ReadCabinetMaterial,WS-ReadChassisMaterial,WS-ReadPeripheralMaterial,WS-ReadServerMaterialintegration/api/odata/ProjectItemAllocateCriterias({key})
PATCHintegration/api/odata/ProjectItemAllocateCriterias({key})
GETWS-ReadCabinet,WS-ReadChassis,WS-ReadServer,WS-ReadNetwork,WS-ReadPeripheral,WS-ReadServerHost,WS-ReadNetworkMaterial,WS-ReadCabinetMaterial,WS-ReadChassisMaterial,WS-ReadPeripheralMaterial,WS-ReadServerMaterialintegration/api/odata/ProjectItemAllocateCriterias

ProjectItemAllocateCriterias Actions

No actions

ProjectItemAllocateCriterias Functions

No functions

ProjectItemAllocateCriterias Custom Routes

CustomRouteRequired 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


ProjectItems Controller

Verb(s)Required Permission(s)LinkDescription
GETWS-ReadChassis,WS-ReadServer,WS-ReadNetwork,WS-ReadPeripheral,WS-ReadServerHost,WS-ReadNetworkMaterial,WS-ReadChassisMaterial,WS-ReadPeripheralMaterial,WS-ReadServerMaterialintegration/api/odata/ProjectItems
GETWS-ReadChassis,WS-ReadServer,WS-ReadNetwork,WS-ReadPeripheral,WS-ReadServerHost,WS-ReadNetworkMaterial,WS-ReadChassisMaterial,WS-ReadPeripheralMaterial,WS-ReadServerMaterialintegration/api/odata/ProjectItems({key})
POSTWS-ReadChassis,WS-ReadServer,WS-ReadChassisMaterial,WS-ReadServerMaterialintegration/api/odata/ProjectItems
DELETEintegration/api/odata/ProjectItems({key})
PATCHintegration/api/odata/ProjectItems({key})

ProjectItems Actions

No actions

ProjectItems Functions

No functions

ProjectItems Custom Routes

CustomRouteRequired 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

NestedPropertySupported Method(s)
ProjectItemAllocateCriteria POST PATCH



Projects Controller

Verb(s)Required Permission(s)LinkDescription
GETintegration/api/odata/Projects
GETintegration/api/odata/Projects({key})
POSTintegration/api/odata/Projects
DELETEintegration/api/odata/Projects({key})
PATCHintegration/api/odata/Projects({key})
POSTintegration/api/odata/Projects({key})

Projects Actions

ActionRequired Permission(s)LinkDescription
AutoAllocateProjectWS-ModifyPredict,WS-ModifyBulkAutoAllocationintegration/api/odata/Projects({key})/AutoAllocateProject(ProjectJobAction={projectjobaction})Initiates the action of allocating the project.

Projects Functions

FunctionRequired Permission(s)LinkDescription
GetAllProjectDependenciesWS-ReadPredict,WS-ReadBulkAutoAllocationintegration/api/odata/Projects/GetAllProjectDependencies(ProjectID={projectid})
ListAllocateCriteriaWS-ReadPredict,WS-ReadBulkAutoAllocationintegration/api/odata/Projects/ListAllocateCriteria(ProjectID={projectid})
GetCompletedItemsWS-ReadPredict,WS-ReadBulkAutoAllocationintegration/api/odata/Projects/GetCompletedItems(ProjectID={projectid})
ListProjectGanttItemsWS-ReadPredict,WS-ReadBulkAutoAllocationintegration/api/odata/Projects/ListProjectGanttItems(StartDate={startdate}, EndDate={enddate}, ProjectType={projecttype}, ProjectStatuses={projectstatuses})
HasProjectItemsWS-ReadPredict,WS-ReadBulkAutoAllocationintegration/api/odata/Projects/HasProjectItems(ProjectID={projectid})
IsProjectValidWS-ReadPredict,WS-ReadBulkAutoAllocationintegration/api/odata/Projects/IsProjectValid(ProjectID={projectid}, ProjectJobAction={projectjobaction})
ListAllocateResultsWS-ReadPredict,WS-ReadBulkAutoAllocationintegration/api/odata/Projects/ListAllocateResults(ProjectID={projectid})
ListRelatedAssetsWS-ReadPredict,WS-ReadBulkAutoAllocationintegration/api/odata/Projects/ListRelatedAssets(ProjectID={projectid}, AssetID={assetid})
ListLinkedItemsWS-ReadPredict,WS-ReadBulkAutoAllocationintegration/api/odata/Projects/ListLinkedItems(ProjectID={projectid})
ProjectAssetSearchWS-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-ReadUPSintegration/api/odata/Projects/ProjectAssetSearch(ProjectType={projecttype}, SearchTerm={searchterm}, RecordStatus={recordstatus}, OperationalStatus={operationalstatus}, MaterialType={materialtype}, LocationGroupID={locationgroupid})

Projects Custom Routes

CustomRouteRequired Permission(s)Supported Method(s)Description
integration/api/odata/ProjectsWS-ModifyPredict,WS-ModifyBulkAutoAllocation DELETE
integration/api/odata/Projects({key})/ProjectItemsWS-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})/ProjectItemAllocateCriteriasWS-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

NestedPropertySupported Method(s)
ProjectItems POST PATCH
ProjectItemAllocateCriterias
ProjectDependencies BIND POST PATCH



Providers Controller

Verb(s)Required Permission(s)LinkDescription
GETintegration/api/odata/Providers({key})
GETintegration/api/odata/Providers
GETintegration/api/odata/Providers({key})

Providers Actions

No actions

Providers Functions

No functions

Providers Custom Routes

No custom routes

Providers Nested Properties

No nested properties


RealTimeDataProviders Controller

Verb(s)Required Permission(s)LinkDescription
POSTWS-AddRealtimeDataProviderintegration/api/odata/RealTimeDataProviders
PATCHWS-ModifyRealtimeDataProviderintegration/api/odata/RealTimeDataProviders({key})
DELETEWS-ModifyRealtimeDataProviderintegration/api/odata/RealTimeDataProviders({key})
GETWS-ReadRealtimeDataProviderintegration/api/odata/RealTimeDataProviders
GETWS-ReadRealtimeDataProviderintegration/api/odata/RealTimeDataProviders({key})

RealTimeDataProviders Actions

No actions

RealTimeDataProviders Functions

No functions

RealTimeDataProviders Custom Routes

CustomRouteRequired 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


RealTimeInfo Controller

Verb(s)Required Permission(s)LinkDescription
POSTWS-AddRealtimeInfointegration/api/odata/RealTimeInfo
PATCHWS-ModifyRealtimeInfointegration/api/odata/RealTimeInfo({key})
DELETEWS-ModifyRealtimeInfointegration/api/odata/RealTimeInfo({key})
GETWS-ReadRealtimeInfointegration/api/odata/RealTimeInfo
GETWS-ReadRealtimeInfointegration/api/odata/RealTimeInfo({key})

RealTimeInfo Actions

No actions

RealTimeInfo Functions

No functions

RealTimeInfo Custom Routes

CustomRouteRequired 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


ReceptacleMaterials Controller

Verb(s)Required Permission(s)LinkDescription
POSTWS-ModifyReceptacleMaterialintegration/api/odata/ReceptacleMaterials({key})
POSTWS-AddReceptacleMaterialintegration/api/odata/ReceptacleMaterials
PATCHWS-ModifyReceptacleMaterialintegration/api/odata/ReceptacleMaterials({key})
DELETEWS-ModifyReceptacleMaterialintegration/api/odata/ReceptacleMaterials({key})
GETWS-ReadReceptacleMaterialintegration/api/odata/ReceptacleMaterials
GETWS-ReadReceptacleMaterialintegration/api/odata/ReceptacleMaterials({key})

ReceptacleMaterials Actions

ActionRequired Permission(s)LinkDescription
CancelWS-ModifyReceptacleMaterialintegration/api/odata/ReceptacleMaterials({key})/Cancel
ActivateWS-ModifyReceptacleMaterialintegration/api/odata/ReceptacleMaterials({key})/ActivateFunction that will move a material in Active status.
DeactivateWS-ModifyReceptacleMaterialintegration/api/odata/ReceptacleMaterials({key})/DeactivateFunction that will move a material in Inactive status.
UploadFileWS-AddFileintegration/api/odata/ReceptacleMaterials({key})/UploadFile(File={file})
DeleteFileWS-ModifyFileintegration/api/odata/ReceptacleMaterials({key})/DeleteFile(FileName={filename})

ReceptacleMaterials Functions

FunctionRequired Permission(s)LinkDescription
DownloadFileWS-ReadFileintegration/api/odata/ReceptacleMaterials({key})/DownloadFile(FileName={filename})
GetAuditLogDataWS-ReadAuditLogintegration/api/odata/ReceptacleMaterials({key})/GetAuditLogDataFunction 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

CustomRouteRequired 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


Receptacles Controller

Verb(s)Required Permission(s)LinkDescription
POSTWS-ModifyReceptacleintegration/api/odata/Receptacles({key})
POSTWS-AddReceptacleintegration/api/odata/Receptacles
PATCHWS-ModifyReceptacleintegration/api/odata/Receptacles({key})
DELETEWS-ModifyReceptacleintegration/api/odata/Receptacles({key})
GETWS-ReadReceptacleintegration/api/odata/Receptacles
GETWS-ReadReceptacleintegration/api/odata/Receptacles({key})

Receptacles Actions

ActionRequired Permission(s)LinkDescription
BeginMoveWS-PlanDecommissionReceptacleintegration/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.
CancelMoveWS-CancelDecommissionReceptacleintegration/api/odata/Receptacles({key})/CancelMoveFunction that is used to cancel planned action. The selected asset will become Active/Operational.
CompleteMoveWS-CompleteDecommissionReceptacleintegration/api/odata/Receptacles({key})/CompleteMoveFunction 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).
DirectMoveWS-SetLocationReceptacleintegration/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.
CompleteCreationWS-ModifyReceptacleintegration/api/odata/Receptacles({key})/CompleteCreationFunction that moves an asset from Planned/(Pre)Procurement to Active/Operational.
SetMaterialWS-SetMaterialReceptacleintegration/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.
AddRealTimeValuesWS-AddAssetRealtimeDataintegration/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.
AddNetworkAssetWS-ReadNetworkConnection,WS-AddNetworkConnectionintegration/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.
RemoveNetworkAssetWS-ModifyNetworkConnectionintegration/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.
UploadFileWS-AddFileintegration/api/odata/Receptacles({key})/UploadFile(File={file})
DeleteFileWS-ModifyFileintegration/api/odata/Receptacles({key})/DeleteFile(FileName={filename})

Receptacles Functions

FunctionRequired Permission(s)LinkDescription
GetTotalSystemPowerConsumptionWS-ReadReceptacleintegration/api/odata/Receptacles({key})/GetTotalSystemPowerConsumptionFunction that returns the TotalSystemPowerConsumption for the selected asset.
GetRealTimePowerInfoWS-ReadReceptacleintegration/api/odata/Receptacles({key})/GetRealTimePowerInfo
GetDiscoveryAssetPageWS-ReadReceptacleintegration/api/odata/Receptacles({key})/GetDiscoveryAssetPageFunction that returns a collection of entities of type Nlyte.Model.AssetMapping. Used to determine external providers.
RecordModifiedInfoWS-ReadReceptacleintegration/api/odata/Receptacles({key})/RecordModifiedInfoFunction that returns an entity of type Nlyte.Model.AuditLogInfo and provides information regarding last modifications against the current asset
GetMountedChildAssetsintegration/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.
GetDistributorsWithFreeOutletsWS-ReadAssetToAssetMappingintegration/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.
SearchAssetNetworkPortLinkageWS-ReadNetworkConnectionintegration/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.
GetRealTimeValuesWS-ReadAssetRealtimeDataintegration/api/odata/Receptacles({key})/GetRealTimeValuesFunction that returns a collection of entities of type Nlyte.Model.RealTimeValue.
GetAssetSummariesintegration/api/odata/Receptacles({key})/GetAssetSummaries(OwnedPeripherals={ownedperipherals}, IncludeHosts={includehosts})
ListPowerConsumersintegration/api/odata/Receptacles({key})/ListPowerConsumersFunction that returns a collection of Nlyte.Model.Graph entities. Used to identify available Output Connector used in power connections.
SupportsPlannedMoveintegration/api/odata/Receptacles({key})/SupportsPlannedMove
GetTotalSystemWeightintegration/api/odata/Receptacles({key})/GetTotalSystemWeightFunction that returns the TotalSystemWeight for the selected asset.
GetMountedOnAssetIDintegration/api/odata/Receptacles({key})/GetMountedOnAssetID
GetAssetsReportDataWS-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-ReadServerHostintegration/api/odata/Receptacles/GetAssetsReportData(assetIds={assetids})
DownloadFileWS-ReadFileintegration/api/odata/Receptacles({key})/DownloadFile(FileName={filename})
GetAuditLogDataWS-ReadAuditLogintegration/api/odata/Receptacles({key})/GetAuditLogDataFunction 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

CustomRouteRequired 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})/CustomFieldsWS-ReadCustomFieldReceptacle GET
integration/api/odata/Receptacles({key})/CustomFieldsWS-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})/WarrantyWS-ReadReceptacle GET
integration/api/odata/Receptacles({key})/WarrantyWS-ModifyReceptacle POST
integration/api/odata/Receptacles({key})/WarrantyWS-ModifyReceptacle PATCH
integration/api/odata/Receptacles({key})/WarrantyWS-ModifyReceptacle DELETE
integration/api/odata/Receptacles({key})/MaintenanceWS-ReadReceptacle GET
integration/api/odata/Receptacles({key})/MaintenanceWS-ModifyReceptacle POST
integration/api/odata/Receptacles({key})/MaintenanceWS-ModifyReceptacle PATCH
integration/api/odata/Receptacles({key})/MaintenanceWS-ModifyReceptacle DELETE
integration/api/odata/Receptacles({key})/AssetMounting GET
integration/api/odata/Receptacles({key})/OwnershipWS-ReadBusinessGroupAssetMap GET
integration/api/odata/Receptacles({key})/Ownership({relatedKey})WS-ReadBusinessGroupAssetMap GET
integration/api/odata/Receptacles({key})/OwnershipWS-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})/SupportWS-ReadSupportGroupAssetMap GET
integration/api/odata/Receptacles({key})/Support({relatedKey})WS-ReadSupportGroupAssetMap GET
integration/api/odata/Receptacles({key})/SupportWS-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

NestedPropertySupported 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



RecordTypes Controller

Verb(s)Required Permission(s)LinkDescription
GETintegration/api/odata/RecordTypes
GETintegration/api/odata/RecordTypes({key})

RecordTypes Actions

No actions

RecordTypes Functions

No functions

RecordTypes Custom Routes

CustomRouteRequired 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


ReportingTags Controller

Verb(s)Required Permission(s)LinkDescription
POSTWS-AddFormintegration/api/odata/ReportingTags
GETintegration/api/odata/ReportingTags
GETintegration/api/odata/ReportingTags({key})

ReportingTags Actions

No actions

ReportingTags Functions

No functions

ReportingTags Custom Routes

CustomRouteRequired 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


Resources Controller

Verb(s)Required Permission(s)LinkDescription
GETintegration/api/odata/Resources
GETintegration/api/odata/Resources({key})

Resources Actions

No actions

Resources Functions

No functions

Resources Custom Routes

CustomRouteRequired 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


Rooms Controller

Verb(s)Required Permission(s)LinkDescription
GETWS-ReadRoomPlanintegration/api/odata/Rooms
PUTWS-ModifyRoomPlanintegration/api/odata/Rooms({key})
GETWS-ReadRoomPlanintegration/api/odata/Rooms({key})

Rooms Actions

No actions

Rooms Functions

FunctionRequired Permission(s)LinkDescription
GetRoomAssetPanelSummaryWS-ReadRoomPlanintegration/api/odata/Rooms({key})/GetRoomAssetPanelSummary
GetLocationWeightWS-ReadRoomPlanintegration/api/odata/Rooms({key})/GetLocationWeight
LoadRoomWS-ReadRoomPlanintegration/api/odata/Rooms/LoadRoom(roomLocationGroupId={roomlocationgroupid})

Rooms Custom Routes

CustomRouteRequired 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


RPPPDUMaterials Controller

Verb(s)Required Permission(s)LinkDescription
POSTWS-AddPDUMaterialintegration/api/odata/RPPPDUMaterials
PATCHWS-ModifyPDUMaterialintegration/api/odata/RPPPDUMaterials({key})
DELETEWS-ModifyPDUMaterialintegration/api/odata/RPPPDUMaterials({key})
GETWS-ReadPDUMaterialintegration/api/odata/RPPPDUMaterials
GETWS-ReadPDUMaterialintegration/api/odata/RPPPDUMaterials({key})

RPPPDUMaterials Actions

ActionRequired Permission(s)LinkDescription
CancelWS-ModifyPDUMaterialintegration/api/odata/RPPPDUMaterials({key})/Cancel
ActivateWS-ModifyPDUMaterialintegration/api/odata/RPPPDUMaterials({key})/ActivateFunction that will move a material in Active status.
DeactivateWS-ModifyPDUMaterialintegration/api/odata/RPPPDUMaterials({key})/DeactivateFunction that will move a material in Inactive status.
UploadFileWS-AddFileintegration/api/odata/RPPPDUMaterials({key})/UploadFile(File={file})
DeleteFileWS-ModifyFileintegration/api/odata/RPPPDUMaterials({key})/DeleteFile(FileName={filename})

RPPPDUMaterials Functions

FunctionRequired Permission(s)LinkDescription
DownloadFileWS-ReadFileintegration/api/odata/RPPPDUMaterials({key})/DownloadFile(FileName={filename})
GetAuditLogDataWS-ReadAuditLogintegration/api/odata/RPPPDUMaterials({key})/GetAuditLogDataFunction 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

CustomRouteRequired Permission(s)Supported Method(s)Description
integration/api/odata/RPPPDUMaterials({key})/Files DELETE

RPPPDUMaterials Nested Properties

No nested properties


SchemeColours Controller

Verb(s)Required Permission(s)LinkDescription
GETintegration/api/odata/SchemeColours
GETintegration/api/odata/SchemeColours({key})

SchemeColours Actions

No actions

SchemeColours Functions

No functions

SchemeColours Custom Routes

No custom routes

SchemeColours Nested Properties

No nested properties


Search Controller

Verb(s)Required Permission(s)LinkDescription
POSTintegration/api/odata/Search

Search Actions

No actions

Search Functions

No functions

Search Custom Routes

CustomRouteRequired Permission(s)Supported Method(s)Description
integration/api/odata/GetAvailableSearchCriteria GET
integration/api/odata/GetMaxAnyAllExpressionDepth GET

Search Nested Properties

No nested properties


ServerHosts Controller

Verb(s)Required Permission(s)LinkDescription
POSTWS-ModifyServerHostintegration/api/odata/ServerHosts({key})
POSTWS-AddServerHostintegration/api/odata/ServerHosts
DELETEWS-ModifyServerHostintegration/api/odata/ServerHosts({key})
PATCHWS-ModifyServerHostintegration/api/odata/ServerHosts({key})
GETWS-ReadServerHostintegration/api/odata/ServerHosts
GETWS-ReadServerHostintegration/api/odata/ServerHosts({key})

ServerHosts Actions

ActionRequired Permission(s)LinkDescription
UpdateBusinessApplicationintegration/api/odata/ServerHosts({key})/UpdateBusinessApplication(BusinessApplicationID={businessapplicationid}, Percentage={percentage})
BeginMoveWS-PlanMoveHost, WS-PlanDecommissionHostintegration/api/odata/ServerHosts({key})/BeginMove(RelocateType={relocatetype})
MoveWS-SetLocationHostintegration/api/odata/ServerHosts({key})/Move(ServerId={serverid})
CancelMoveWS-CancelMoveHost, WS-CancelDecommissionHostintegration/api/odata/ServerHosts({key})/CancelMove
CompleteMoveWS-CompleteMoveHost, WS-CompleteDecommissionHostintegration/api/odata/ServerHosts({key})/CompleteMove
UploadFileWS-AddFileintegration/api/odata/ServerHosts({key})/UploadFile(File={file})
DeleteFileWS-ModifyFileintegration/api/odata/ServerHosts({key})/DeleteFile(FileName={filename})

ServerHosts Functions

FunctionRequired Permission(s)LinkDescription
GetConventionSetsintegration/api/odata/ServerHosts/GetConventionSets(EntityTypeID={entitytypeid})
GetConventionsintegration/api/odata/ServerHosts/GetConventions(ConventionSetID={conventionsetid})
GenerateConventionNameintegration/api/odata/ServerHosts/GenerateConventionName(ConventionID={conventionid})
RecordModifiedInfoWS-ReadServerHostintegration/api/odata/ServerHosts({key})/RecordModifiedInfoFunction that returns an entity of type Nlyte.Model.AuditLogInfo and provides information regarding last modifications against the current asset
GetDiscoveryHostPageWS-ReadServerHostintegration/api/odata/ServerHosts({key})/GetDiscoveryHostPageFunction that returns a collection of entities of type Nlyte.Model.HostMapping. Used to determine external providers.
DownloadFileWS-ReadFileintegration/api/odata/ServerHosts({key})/DownloadFile(FileName={filename})
GetConventionSetsintegration/api/odata/ServerHosts/GetConventionSets(EntityTypeID={entitytypeid})
GetConventionsintegration/api/odata/ServerHosts/GetConventions(ConventionSetID={conventionsetid})
GenerateConventionNameintegration/api/odata/ServerHosts/GenerateConventionName(ConventionID={conventionid})

ServerHosts Custom Routes

CustomRouteRequired Permission(s)Supported Method(s)Description
integration/api/odata/ServerHosts({key})/OwnershipWS-AddServerHostBusinessGroupMap POST
integration/api/odata/ServerHosts({key})/SupportWS-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})/OwnershipWS-ModifyServerHostBusinessGroupMap DELETE
integration/api/odata/ServerHosts({key})/Ownership({relatedKey})WS-ModifyServerHostBusinessGroupMap DELETE
integration/api/odata/ServerHosts({key})/OwnershipWS-ReadServerHostBusinessGroupMap GET
integration/api/odata/ServerHosts({key})/Ownership({relatedKey})WS-ReadServerHostBusinessGroupMap GET
integration/api/odata/ServerHosts({key})/SupportWS-ModifyServerHostSupportGroupMap DELETE
integration/api/odata/ServerHosts({key})/Support({relatedKey})WS-ModifyServerHostSupportGroupMap DELETE
integration/api/odata/ServerHosts({key})/SupportWS-ReadServerHostSupportGroupMap GET
integration/api/odata/ServerHosts({key})/Support({relatedKey})WS-ReadServerHostSupportGroupMap GET
integration/api/odata/ServerHosts({key})/BusinessApplicationServerHostsWS-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

NestedPropertySupported 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



ServerMaterials Controller

Verb(s)Required Permission(s)LinkDescription
POSTWS-ModifyServerMaterialintegration/api/odata/ServerMaterials({key})
POSTWS-AddServerMaterialintegration/api/odata/ServerMaterials
PATCHWS-ModifyServerMaterialintegration/api/odata/ServerMaterials({key})
DELETEWS-ModifyServerMaterialintegration/api/odata/ServerMaterials({key})
GETWS-ReadServerMaterialintegration/api/odata/ServerMaterials
GETWS-ReadServerMaterialintegration/api/odata/ServerMaterials({key})

ServerMaterials Actions

ActionRequired Permission(s)LinkDescription
CancelWS-ModifyServerMaterialintegration/api/odata/ServerMaterials({key})/Cancel
ActivateWS-ModifyServerMaterialintegration/api/odata/ServerMaterials({key})/ActivateFunction that will move a material in Active status.
DeactivateWS-ModifyServerMaterialintegration/api/odata/ServerMaterials({key})/DeactivateFunction that will move a material in Inactive status.
UploadFileWS-AddFileintegration/api/odata/ServerMaterials({key})/UploadFile(File={file})
DeleteFileWS-ModifyFileintegration/api/odata/ServerMaterials({key})/DeleteFile(FileName={filename})

ServerMaterials Functions

FunctionRequired Permission(s)LinkDescription
DownloadFileWS-ReadFileintegration/api/odata/ServerMaterials({key})/DownloadFile(FileName={filename})
GetAuditLogDataWS-ReadAuditLogintegration/api/odata/ServerMaterials({key})/GetAuditLogDataFunction 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

CustomRouteRequired 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


Servers Controller

Verb(s)Required Permission(s)LinkDescription
GETWS-ReadServerintegration/api/odata/Servers
PATCHWS-ModifyServerintegration/api/odata/Servers({key})
POSTWS-AddServerintegration/api/odata/Servers
POSTWS-ModifyServerintegration/api/odata/Servers({key})
DELETEWS-ModifyServerintegration/api/odata/Servers({key})
GETWS-ReadServerintegration/api/odata/Servers({key})

Servers Actions

ActionRequired Permission(s)LinkDescription
BeginMoveWS-PlanMoveServer, WS-PlanRecycleServer, WS-PlanDecommissionServerintegration/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.
CancelMoveWS-CancelMoveServer, WS-CancelRecycleServer, WS-CancelDecommissionServerintegration/api/odata/Servers({key})/CancelMoveFunction that is used to cancel planned action. The selected asset will become Active/Operational.
CompleteMoveWS-CompleteMoveServer, WS-CompleteRecycleServer, WS-CompleteDecommissionServerintegration/api/odata/Servers({key})/CompleteMoveFunction 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).
DirectMoveWS-SetLocationServerintegration/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.
CompleteCreationWS-ModifyServerintegration/api/odata/Servers({key})/CompleteCreationFunction that moves an asset from Planned/(Pre)Procurement to Active/Operational.
SetMaterialintegration/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.
AddRealTimeValuesWS-AddAssetRealtimeDataintegration/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.
AddNetworkAssetWS-ReadNetworkConnection,WS-AddNetworkConnectionintegration/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.
RemoveNetworkAssetWS-ModifyNetworkConnectionintegration/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.
UploadFileWS-AddFileintegration/api/odata/Servers({key})/UploadFile(File={file})
DeleteFileWS-ModifyFileintegration/api/odata/Servers({key})/DeleteFile(FileName={filename})

Servers Functions

FunctionRequired Permission(s)LinkDescription
ListLinkedRecordsintegration/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.
GetTotalSystemPowerConsumptionWS-ReadServerintegration/api/odata/Servers({key})/GetTotalSystemPowerConsumptionFunction that returns the TotalSystemPowerConsumption for the selected asset.
GetAssetAllocationCriteriaWS-ReadServerintegration/api/odata/Servers({key})/GetAssetAllocationCriteriaUsed to retrieve Nlyte.Model.AssetAllocationCriteria representing the available allocation criteria used in auto-allocation.
GetRealTimePowerInfoWS-ReadServerintegration/api/odata/Servers({key})/GetRealTimePowerInfo
GetDiscoveryAssetPageWS-ReadServerintegration/api/odata/Servers({key})/GetDiscoveryAssetPageFunction that returns a collection of entities of type Nlyte.Model.AssetMapping. Used to determine external providers.
RecordModifiedInfoWS-ReadServerintegration/api/odata/Servers({key})/RecordModifiedInfoFunction that returns an entity of type Nlyte.Model.AuditLogInfo and provides information regarding last modifications against the current asset
GetChassisWithFreeSlotsWS-ReadChassisintegration/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.
GetMountedChildAssetsintegration/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.
GetDistributorsWithFreeOutletsWS-ReadAssetToAssetMappingintegration/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.
SearchAssetNetworkPortLinkageWS-ReadNetworkConnectionintegration/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.
GetRealTimeValuesWS-ReadAssetRealtimeDataintegration/api/odata/Servers({key})/GetRealTimeValuesFunction that returns a collection of entities of type Nlyte.Model.RealTimeValue.
GetAssetSummariesintegration/api/odata/Servers({key})/GetAssetSummaries(OwnedPeripherals={ownedperipherals}, IncludeHosts={includehosts})
GetNetworkCardPortsInfoWS-ReadNetworkConnectionintegration/api/odata/Servers({key})/GetNetworkCardPortsInfoReturns an object of type Nlyte.Model.NetworkResults having information about Copper and Fiber Ports
GetNetworkCardPortConnectionsWS-ReadNetworkConnectionintegration/api/odata/Servers({key})/GetNetworkCardPortConnectionsReturns an object of type Nlyte.Model.NetworkResults having information about Copper and Fiber Port connections
GetNetworkAssetSummaryWS-ReadNetworkConnectionintegration/api/odata/Servers({key})/GetNetworkAssetSummaryReturns an object of type Nlyte.Model.NetworkResults having information about the networkable assets.
ListPowerConsumersintegration/api/odata/Servers({key})/ListPowerConsumersFunction that returns a collection of Nlyte.Model.Graph entities. Used to identify available Output Connector used in power connections.
SupportsPlannedMoveintegration/api/odata/Servers({key})/SupportsPlannedMove
GetTotalSystemWeightintegration/api/odata/Servers({key})/GetTotalSystemWeightFunction that returns the TotalSystemWeight for the selected asset.
GetMountedOnAssetIDintegration/api/odata/Servers({key})/GetMountedOnAssetID
GetAssetsReportDataWS-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-ReadServerHostintegration/api/odata/Servers/GetAssetsReportData(assetIds={assetids})
GetConventionSetsintegration/api/odata/Servers/GetConventionSets(EntityTypeID={entitytypeid})
GetConventionsintegration/api/odata/Servers/GetConventions(ConventionSetID={conventionsetid})
GenerateConventionNameintegration/api/odata/Servers/GenerateConventionName(ConventionID={conventionid})
DownloadFileWS-ReadFileintegration/api/odata/Servers({key})/DownloadFile(FileName={filename})
GetConventionSetsintegration/api/odata/Servers/GetConventionSets(EntityTypeID={entitytypeid})
GetConventionsintegration/api/odata/Servers/GetConventions(ConventionSetID={conventionsetid})
GenerateConventionNameintegration/api/odata/Servers/GenerateConventionName(ConventionID={conventionid})
GetAuditLogDataWS-ReadAuditLogintegration/api/odata/Servers({key})/GetAuditLogDataFunction 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

CustomRouteRequired 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})/CustomFieldsWS-ReadCustomFieldServer GET
integration/api/odata/Servers({key})/CustomFieldsWS-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})/WarrantyWS-ReadServer GET
integration/api/odata/Servers({key})/WarrantyWS-ModifyServer POST
integration/api/odata/Servers({key})/WarrantyWS-ModifyServer PATCH
integration/api/odata/Servers({key})/WarrantyWS-ModifyServer DELETE
integration/api/odata/Servers({key})/MaintenanceWS-ReadServer GET
integration/api/odata/Servers({key})/MaintenanceWS-ModifyServer POST
integration/api/odata/Servers({key})/MaintenanceWS-ModifyServer PATCH
integration/api/odata/Servers({key})/MaintenanceWS-ModifyServer DELETE
integration/api/odata/Servers({key})/AssetMounting GET
integration/api/odata/Servers({key})/KvmSwitchPortConsumerLinks({relatedKey})WS-ModifyKVMSwitchPortConsumerLink DELETE
integration/api/odata/Servers({key})/OwnershipWS-ReadBusinessGroupAssetMap GET
integration/api/odata/Servers({key})/Ownership({relatedKey})WS-ReadBusinessGroupAssetMap GET
integration/api/odata/Servers({key})/OwnershipWS-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})/SupportWS-ReadSupportGroupAssetMap GET
integration/api/odata/Servers({key})/Support({relatedKey})WS-ReadSupportGroupAssetMap GET
integration/api/odata/Servers({key})/SupportWS-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

NestedPropertySupported 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



ServiceRequests Controller

Verb(s)Required Permission(s)LinkDescription
PUTWS-ModifyServiceRequestintegration/api/odata/ServiceRequests({key})
POSTWS-AddServiceRequestintegration/api/odata/ServiceRequests
POSTintegration/api/odata/ServiceRequests({key})
PATCHWS-ModifyServiceRequestintegration/api/odata/ServiceRequests({key})
GETWS-ReadServiceRequestintegration/api/odata/ServiceRequests
GETWS-ReadServiceRequestintegration/api/odata/ServiceRequests({key})

ServiceRequests Actions

ActionRequired Permission(s)LinkDescription
CopyWS-AddServiceRequestintegration/api/odata/ServiceRequests({key})/Copy
StartWS-AddServiceRequest, WS-ModifyServiceRequestintegration/api/odata/ServiceRequests({key})/Start(ServiceRequest={servicerequest})
SetStatusWS-ModifyServiceRequestintegration/api/odata/ServiceRequests({key})/SetStatus(Status={status})
CreateAssetintegration/api/odata/ServiceRequests({key})/CreateAsset(Asset={asset})
UploadFileWS-AddFileintegration/api/odata/ServiceRequests({key})/UploadFile(File={file})
DeleteFileWS-ModifyFileintegration/api/odata/ServiceRequests({key})/DeleteFile(FileName={filename})

ServiceRequests Functions

FunctionRequired Permission(s)LinkDescription
GetMyGroupsRequestsWS-ReadServiceRequestintegration/api/odata/ServiceRequests/GetMyGroupsRequests
InstantiateFromDefinitionWS-ReadProcessintegration/api/odata/ServiceRequests/InstantiateFromDefinition(ProcessID={processid}, RequestedByAssigneeID={requestedbyassigneeid})
GetAssetServiceRequestsWS-ReadServiceRequestintegration/api/odata/ServiceRequests({key})/GetAssetServiceRequests(assetIds={assetids})
DownloadFileWS-ReadFileintegration/api/odata/ServiceRequests({key})/DownloadFile(FileName={filename})
GetControlAssetsWS-ReadGetControlAssetsintegration/api/odata/ServiceRequests({key})/GetControlAssets(formControlId={formcontrolid})

ServiceRequests Custom Routes

CustomRouteRequired 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


Shelfs Controller

Verb(s)Required Permission(s)LinkDescription
POSTWS-AddShelfintegration/api/odata/Shelfs
DELETEintegration/api/odata/Shelfs({key})
PATCHWS-ModifyShelfintegration/api/odata/Shelfs({key})
GETWS-ReadShelfintegration/api/odata/Shelfs
GETWS-ReadShelfintegration/api/odata/Shelfs({key})

Shelfs Actions

No actions

Shelfs Functions

No functions

Shelfs Custom Routes

CustomRouteRequired 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


SoftwareManufacturers Controller

Verb(s)Required Permission(s)LinkDescription
GETintegration/api/odata/SoftwareManufacturers
GETintegration/api/odata/SoftwareManufacturers({key})

SoftwareManufacturers Actions

No actions

SoftwareManufacturers Functions

No functions

SoftwareManufacturers Custom Routes

CustomRouteRequired 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


Softwares Controller

Verb(s)Required Permission(s)LinkDescription
POSTWS-AddSoftwareintegration/api/odata/Softwares
DELETEWS-ModifySoftwareintegration/api/odata/Softwares({key})
PATCHWS-ModifySoftwareintegration/api/odata/Softwares({key})
GETWS-ReadSoftwareintegration/api/odata/Softwares
GETWS-ReadSoftwareintegration/api/odata/Softwares({key})

Softwares Actions

ActionRequired Permission(s)LinkDescription
Cancelintegration/api/odata/Softwares({key})/CancelFunction that will cancel/delete a software in Planned status.
Activateintegration/api/odata/Softwares({key})/ActivateFunction that will move a software in Active status.
Deactivateintegration/api/odata/Softwares({key})/Deactivate
UploadFileWS-AddFileintegration/api/odata/Softwares({key})/UploadFile(File={file})
DeleteFileWS-ModifyFileintegration/api/odata/Softwares({key})/DeleteFile(FileName={filename})

Softwares Functions

FunctionRequired Permission(s)LinkDescription
DownloadFileWS-ReadFileintegration/api/odata/Softwares({key})/DownloadFile(FileName={filename})

Softwares Custom Routes

CustomRouteRequired 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


SoftwareTypes Controller

Verb(s)Required Permission(s)LinkDescription
GETintegration/api/odata/SoftwareTypes
GETintegration/api/odata/SoftwareTypes({key})

SoftwareTypes Actions

No actions

SoftwareTypes Functions

No functions

SoftwareTypes Custom Routes

CustomRouteRequired 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


StandardGeneratorAuxiliaryMaterials Controller

Verb(s)Required Permission(s)LinkDescription
POSTWS-AddAuxiliaryMaterialintegration/api/odata/StandardGeneratorAuxiliaryMaterials
PATCHWS-ModifyAuxiliaryMaterialintegration/api/odata/StandardGeneratorAuxiliaryMaterials({key})
DELETEWS-ModifyAuxiliaryMaterialintegration/api/odata/StandardGeneratorAuxiliaryMaterials({key})
GETWS-ReadAuxiliaryMaterialintegration/api/odata/StandardGeneratorAuxiliaryMaterials
GETWS-ReadAuxiliaryMaterialintegration/api/odata/StandardGeneratorAuxiliaryMaterials({key})

StandardGeneratorAuxiliaryMaterials Actions

ActionRequired Permission(s)LinkDescription
CancelWS-ModifyAuxiliaryMaterialintegration/api/odata/StandardGeneratorAuxiliaryMaterials({key})/Cancel
ActivateWS-ModifyAuxiliaryMaterialintegration/api/odata/StandardGeneratorAuxiliaryMaterials({key})/ActivateFunction that will move a material in Active status.
DeactivateWS-ModifyAuxiliaryMaterialintegration/api/odata/StandardGeneratorAuxiliaryMaterials({key})/DeactivateFunction that will move a material in Inactive status.
UploadFileWS-AddFileintegration/api/odata/StandardGeneratorAuxiliaryMaterials({key})/UploadFile(File={file})
DeleteFileWS-ModifyFileintegration/api/odata/StandardGeneratorAuxiliaryMaterials({key})/DeleteFile(FileName={filename})

StandardGeneratorAuxiliaryMaterials Functions

FunctionRequired Permission(s)LinkDescription
DownloadFileWS-ReadFileintegration/api/odata/StandardGeneratorAuxiliaryMaterials({key})/DownloadFile(FileName={filename})
GetAuditLogDataWS-ReadAuditLogintegration/api/odata/StandardGeneratorAuxiliaryMaterials({key})/GetAuditLogDataFunction 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

CustomRouteRequired 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


StandardNetworkMaterials Controller

Verb(s)Required Permission(s)LinkDescription
POSTWS-ModifyNetworkMaterialintegration/api/odata/StandardNetworkMaterials({key})
POSTWS-AddNetworkMaterialintegration/api/odata/StandardNetworkMaterials
PATCHWS-ModifyNetworkMaterialintegration/api/odata/StandardNetworkMaterials({key})
DELETEWS-ModifyNetworkMaterialintegration/api/odata/StandardNetworkMaterials({key})
GETWS-ReadNetworkMaterialintegration/api/odata/StandardNetworkMaterials
GETWS-ReadNetworkMaterialintegration/api/odata/StandardNetworkMaterials({key})

StandardNetworkMaterials Actions

ActionRequired Permission(s)LinkDescription
CancelWS-ModifyNetworkMaterialintegration/api/odata/StandardNetworkMaterials({key})/Cancel
ActivateWS-ModifyNetworkMaterialintegration/api/odata/StandardNetworkMaterials({key})/ActivateFunction that will move a material in Active status.
DeactivateWS-ModifyNetworkMaterialintegration/api/odata/StandardNetworkMaterials({key})/DeactivateFunction that will move a material in Inactive status.
UploadFileWS-AddFileintegration/api/odata/StandardNetworkMaterials({key})/UploadFile(File={file})
DeleteFileWS-ModifyFileintegration/api/odata/StandardNetworkMaterials({key})/DeleteFile(FileName={filename})

StandardNetworkMaterials Functions

FunctionRequired Permission(s)LinkDescription
DownloadFileWS-ReadFileintegration/api/odata/StandardNetworkMaterials({key})/DownloadFile(FileName={filename})
GetAuditLogDataWS-ReadAuditLogintegration/api/odata/StandardNetworkMaterials({key})/GetAuditLogDataFunction 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

CustomRouteRequired 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


StandardPDUMaterials Controller

Verb(s)Required Permission(s)LinkDescription
POSTWS-AddPDUMaterialintegration/api/odata/StandardPDUMaterials
PATCHWS-ModifyPDUMaterialintegration/api/odata/StandardPDUMaterials({key})
DELETEWS-ModifyPDUMaterialintegration/api/odata/StandardPDUMaterials({key})
GETWS-ReadPDUMaterialintegration/api/odata/StandardPDUMaterials
GETWS-ReadPDUMaterialintegration/api/odata/StandardPDUMaterials({key})

StandardPDUMaterials Actions

ActionRequired Permission(s)LinkDescription
CancelWS-ModifyPDUMaterialintegration/api/odata/StandardPDUMaterials({key})/Cancel
ActivateWS-ModifyPDUMaterialintegration/api/odata/StandardPDUMaterials({key})/ActivateFunction that will move a material in Active status.
DeactivateWS-ModifyPDUMaterialintegration/api/odata/StandardPDUMaterials({key})/DeactivateFunction that will move a material in Inactive status.
UploadFileWS-AddFileintegration/api/odata/StandardPDUMaterials({key})/UploadFile(File={file})
DeleteFileWS-ModifyFileintegration/api/odata/StandardPDUMaterials({key})/DeleteFile(FileName={filename})

StandardPDUMaterials Functions

FunctionRequired Permission(s)LinkDescription
DownloadFileWS-ReadFileintegration/api/odata/StandardPDUMaterials({key})/DownloadFile(FileName={filename})
GetAuditLogDataWS-ReadAuditLogintegration/api/odata/StandardPDUMaterials({key})/GetAuditLogDataFunction 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

CustomRouteRequired 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


StandardServerMaterials Controller

Verb(s)Required Permission(s)LinkDescription
POSTWS-ModifyServerMaterialintegration/api/odata/StandardServerMaterials({key})
POSTWS-AddServerMaterialintegration/api/odata/StandardServerMaterials
PATCHWS-ModifyServerMaterialintegration/api/odata/StandardServerMaterials({key})
DELETEWS-ModifyServerMaterialintegration/api/odata/StandardServerMaterials({key})
GETWS-ReadServerMaterialintegration/api/odata/StandardServerMaterials
GETWS-ReadServerMaterialintegration/api/odata/StandardServerMaterials({key})

StandardServerMaterials Actions

ActionRequired Permission(s)LinkDescription
CancelWS-ModifyServerMaterialintegration/api/odata/StandardServerMaterials({key})/Cancel
ActivateWS-ModifyServerMaterialintegration/api/odata/StandardServerMaterials({key})/ActivateFunction that will move a material in Active status.
DeactivateWS-ModifyServerMaterialintegration/api/odata/StandardServerMaterials({key})/DeactivateFunction that will move a material in Inactive status.
UploadFileWS-AddFileintegration/api/odata/StandardServerMaterials({key})/UploadFile(File={file})
DeleteFileWS-ModifyFileintegration/api/odata/StandardServerMaterials({key})/DeleteFile(FileName={filename})

StandardServerMaterials Functions

FunctionRequired Permission(s)LinkDescription
DownloadFileWS-ReadFileintegration/api/odata/StandardServerMaterials({key})/DownloadFile(FileName={filename})
GetAuditLogDataWS-ReadAuditLogintegration/api/odata/StandardServerMaterials({key})/GetAuditLogDataFunction 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

CustomRouteRequired 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


StaticSwitches Controller

Verb(s)Required Permission(s)LinkDescription
PATCHWS-ModifyStaticSwitchintegration/api/odata/StaticSwitches({key})
POSTWS-AddStaticSwitchintegration/api/odata/StaticSwitches
DELETEWS-ModifyStaticSwitchintegration/api/odata/StaticSwitches({key})
POSTWS-ModifyStaticSwitchintegration/api/odata/StaticSwitches({key})
GETWS-ReadStaticSwitchintegration/api/odata/StaticSwitches
GETWS-ReadStaticSwitchintegration/api/odata/StaticSwitches({key})

StaticSwitches Actions

ActionRequired Permission(s)LinkDescription
BeginMoveWS-PlanRecycleStaticSwitch, WS-PlanDecommissionStaticSwitchintegration/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.
CancelMoveWS-CancelRecycleStaticSwitch, WS-CancelDecommissionStaticSwitchintegration/api/odata/StaticSwitches({key})/CancelMoveFunction that is used to cancel planned action. The selected asset will become Active/Operational.
CompleteMoveWS-CompleteRecycleStaticSwitch, WS-CompleteDecommissionStaticSwitchintegration/api/odata/StaticSwitches({key})/CompleteMoveFunction 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).
DirectMoveWS-SetLocationStaticSwitchintegration/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.
CompleteCreationWS-ModifyStaticSwitchintegration/api/odata/StaticSwitches({key})/CompleteCreationFunction that moves an asset from Planned/(Pre)Procurement to Active/Operational.
SetMaterialintegration/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.
AddRealTimeValuesWS-AddAssetRealtimeDataintegration/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.
AddNetworkAssetWS-ReadNetworkConnection,WS-AddNetworkConnectionintegration/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.
RemoveNetworkAssetWS-ModifyNetworkConnectionintegration/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.
UploadFileWS-AddFileintegration/api/odata/StaticSwitches({key})/UploadFile(File={file})
DeleteFileWS-ModifyFileintegration/api/odata/StaticSwitches({key})/DeleteFile(FileName={filename})

StaticSwitches Functions

FunctionRequired Permission(s)LinkDescription
GetTotalSystemPowerConsumptionWS-ReadStaticSwitchintegration/api/odata/StaticSwitches({key})/GetTotalSystemPowerConsumptionFunction that returns the TotalSystemPowerConsumption for the selected asset.
GetRealTimePowerInfoWS-ReadStaticSwitchintegration/api/odata/StaticSwitches({key})/GetRealTimePowerInfo
GetDiscoveryAssetPageWS-ReadStaticSwitchintegration/api/odata/StaticSwitches({key})/GetDiscoveryAssetPageFunction that returns a collection of entities of type Nlyte.Model.AssetMapping. Used to determine external providers.
RecordModifiedInfoWS-ReadStaticSwitchintegration/api/odata/StaticSwitches({key})/RecordModifiedInfoFunction that returns an entity of type Nlyte.Model.AuditLogInfo and provides information regarding last modifications against the current asset
GetMountedChildAssetsintegration/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.
GetDistributorsWithFreeOutletsWS-ReadAssetToAssetMappingintegration/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.
SearchAssetNetworkPortLinkageWS-ReadNetworkConnectionintegration/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.
GetRealTimeValuesWS-ReadAssetRealtimeDataintegration/api/odata/StaticSwitches({key})/GetRealTimeValuesFunction that returns a collection of entities of type Nlyte.Model.RealTimeValue.
GetAssetSummariesintegration/api/odata/StaticSwitches({key})/GetAssetSummaries(OwnedPeripherals={ownedperipherals}, IncludeHosts={includehosts})
GetNetworkCardPortsInfoWS-ReadNetworkConnectionintegration/api/odata/StaticSwitches({key})/GetNetworkCardPortsInfoReturns an object of type Nlyte.Model.NetworkResults having information about Copper and Fiber Ports
GetNetworkCardPortConnectionsWS-ReadNetworkConnectionintegration/api/odata/StaticSwitches({key})/GetNetworkCardPortConnectionsReturns an object of type Nlyte.Model.NetworkResults having information about Copper and Fiber Port connections
GetNetworkAssetSummaryWS-ReadNetworkConnectionintegration/api/odata/StaticSwitches({key})/GetNetworkAssetSummaryReturns an object of type Nlyte.Model.NetworkResults having information about the networkable assets.
ListPowerConsumersintegration/api/odata/StaticSwitches({key})/ListPowerConsumersFunction that returns a collection of Nlyte.Model.Graph entities. Used to identify available Output Connector used in power connections.
SupportsPlannedMoveintegration/api/odata/StaticSwitches({key})/SupportsPlannedMove
GetTotalSystemWeightintegration/api/odata/StaticSwitches({key})/GetTotalSystemWeightFunction that returns the TotalSystemWeight for the selected asset.
GetMountedOnAssetIDintegration/api/odata/StaticSwitches({key})/GetMountedOnAssetID
GetAssetsReportDataWS-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-ReadServerHostintegration/api/odata/StaticSwitches/GetAssetsReportData(assetIds={assetids})
DownloadFileWS-ReadFileintegration/api/odata/StaticSwitches({key})/DownloadFile(FileName={filename})
GetAuditLogDataWS-ReadAuditLogintegration/api/odata/StaticSwitches({key})/GetAuditLogDataFunction 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

CustomRouteRequired 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})/CustomFieldsWS-ReadCustomFieldStaticSwitch GET
integration/api/odata/StaticSwitches({key})/CustomFieldsWS-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})/WarrantyWS-ReadStaticSwitch GET
integration/api/odata/StaticSwitches({key})/WarrantyWS-ModifyStaticSwitch POST
integration/api/odata/StaticSwitches({key})/WarrantyWS-ModifyStaticSwitch PATCH
integration/api/odata/StaticSwitches({key})/WarrantyWS-ModifyStaticSwitch DELETE
integration/api/odata/StaticSwitches({key})/MaintenanceWS-ReadStaticSwitch GET
integration/api/odata/StaticSwitches({key})/MaintenanceWS-ModifyStaticSwitch POST
integration/api/odata/StaticSwitches({key})/MaintenanceWS-ModifyStaticSwitch PATCH
integration/api/odata/StaticSwitches({key})/MaintenanceWS-ModifyStaticSwitch DELETE
integration/api/odata/StaticSwitches({key})/AssetMounting GET
integration/api/odata/StaticSwitches({key})/OwnershipWS-ReadBusinessGroupAssetMap GET
integration/api/odata/StaticSwitches({key})/Ownership({relatedKey})WS-ReadBusinessGroupAssetMap GET
integration/api/odata/StaticSwitches({key})/OwnershipWS-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})/SupportWS-ReadSupportGroupAssetMap GET
integration/api/odata/StaticSwitches({key})/Support({relatedKey})WS-ReadSupportGroupAssetMap GET
integration/api/odata/StaticSwitches({key})/SupportWS-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

NestedPropertySupported 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



StaticSwitchMaterials Controller

Verb(s)Required Permission(s)LinkDescription
POSTWS-ModifyStaticSwitchMaterialintegration/api/odata/StaticSwitchMaterials({key})
POSTWS-AddStaticSwitchMaterialintegration/api/odata/StaticSwitchMaterials
PATCHWS-ModifyStaticSwitchMaterialintegration/api/odata/StaticSwitchMaterials({key})
DELETEWS-ModifyStaticSwitchMaterialintegration/api/odata/StaticSwitchMaterials({key})
GETWS-ReadStaticSwitchMaterialintegration/api/odata/StaticSwitchMaterials
GETWS-ReadStaticSwitchMaterialintegration/api/odata/StaticSwitchMaterials({key})

StaticSwitchMaterials Actions

ActionRequired Permission(s)LinkDescription
CancelWS-ModifyStaticSwitchMaterialintegration/api/odata/StaticSwitchMaterials({key})/Cancel
ActivateWS-ModifyStaticSwitchMaterialintegration/api/odata/StaticSwitchMaterials({key})/ActivateFunction that will move a material in Active status.
DeactivateWS-ModifyStaticSwitchMaterialintegration/api/odata/StaticSwitchMaterials({key})/DeactivateFunction that will move a material in Inactive status.
UploadFileWS-AddFileintegration/api/odata/StaticSwitchMaterials({key})/UploadFile(File={file})
DeleteFileWS-ModifyFileintegration/api/odata/StaticSwitchMaterials({key})/DeleteFile(FileName={filename})

StaticSwitchMaterials Functions

FunctionRequired Permission(s)LinkDescription
DownloadFileWS-ReadFileintegration/api/odata/StaticSwitchMaterials({key})/DownloadFile(FileName={filename})
GetAuditLogDataWS-ReadAuditLogintegration/api/odata/StaticSwitchMaterials({key})/GetAuditLogDataFunction 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

CustomRouteRequired 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


StoragePeripheralMaterials Controller

Verb(s)Required Permission(s)LinkDescription
POSTWS-ModifyPeripheralMaterialintegration/api/odata/StoragePeripheralMaterials({key})
POSTWS-AddPeripheralMaterialintegration/api/odata/StoragePeripheralMaterials
PATCHWS-ModifyPeripheralMaterialintegration/api/odata/StoragePeripheralMaterials({key})
DELETEWS-ModifyPeripheralMaterialintegration/api/odata/StoragePeripheralMaterials({key})
GETWS-ReadPeripheralMaterialintegration/api/odata/StoragePeripheralMaterials
GETWS-ReadPeripheralMaterialintegration/api/odata/StoragePeripheralMaterials({key})

StoragePeripheralMaterials Actions

ActionRequired Permission(s)LinkDescription
CancelWS-ModifyPeripheralMaterialintegration/api/odata/StoragePeripheralMaterials({key})/Cancel
ActivateWS-ModifyPeripheralMaterialintegration/api/odata/StoragePeripheralMaterials({key})/ActivateFunction that will move a material in Active status.
DeactivateWS-ModifyPeripheralMaterialintegration/api/odata/StoragePeripheralMaterials({key})/DeactivateFunction that will move a material in Inactive status.
UploadFileWS-AddFileintegration/api/odata/StoragePeripheralMaterials({key})/UploadFile(File={file})
DeleteFileWS-ModifyFileintegration/api/odata/StoragePeripheralMaterials({key})/DeleteFile(FileName={filename})

StoragePeripheralMaterials Functions

FunctionRequired Permission(s)LinkDescription
DownloadFileWS-ReadFileintegration/api/odata/StoragePeripheralMaterials({key})/DownloadFile(FileName={filename})
GetAuditLogDataWS-ReadAuditLogintegration/api/odata/StoragePeripheralMaterials({key})/GetAuditLogDataFunction 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

CustomRouteRequired 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


SubnetLocationGroupMaps Controller

Verb(s)Required Permission(s)LinkDescription
POSTWS-AddSubnetLocationGroupMapintegration/api/odata/SubnetLocationGroupMaps
DELETEWS-ModifySubnetLocationGroupMapintegration/api/odata/SubnetLocationGroupMaps({key})
PATCHWS-ModifySubnetLocationGroupMapintegration/api/odata/SubnetLocationGroupMaps({key})
GETWS-ReadSubnetLocationGroupMapintegration/api/odata/SubnetLocationGroupMaps
GETWS-ReadSubnetLocationGroupMapintegration/api/odata/SubnetLocationGroupMaps({key})

SubnetLocationGroupMaps Actions

No actions

SubnetLocationGroupMaps Functions

No functions

SubnetLocationGroupMaps Custom Routes

CustomRouteRequired 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


Subnets Controller

Verb(s)Required Permission(s)LinkDescription
POSTWS-AddCabinetSubnetMapintegration/api/odata/Subnets
DELETEWS-ModifyCabinetSubnetMapintegration/api/odata/Subnets({key})
PATCHWS-ModifyCabinetSubnetMapintegration/api/odata/Subnets({key})
GETWS-ReadCabinetSubnetMapintegration/api/odata/Subnets
GETWS-ReadCabinetSubnetMapintegration/api/odata/Subnets({key})

Subnets Actions

No actions

Subnets Functions

No functions

Subnets Custom Routes

CustomRouteRequired 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


SupplierMaterials Controller

Verb(s)Required Permission(s)LinkDescription
GETintegration/api/odata/SupplierMaterials
GETintegration/api/odata/SupplierMaterials({key})

SupplierMaterials Actions

No actions

SupplierMaterials Functions

No functions

SupplierMaterials Custom Routes

CustomRouteRequired 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


SupplierMaterialWires Controller

Verb(s)Required Permission(s)LinkDescription
GETintegration/api/odata/SupplierMaterialWires
GETintegration/api/odata/SupplierMaterialWires({key})

SupplierMaterialWires Actions

No actions

SupplierMaterialWires Functions

No functions

SupplierMaterialWires Custom Routes

CustomRouteRequired 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


SupportGroups Controller

Verb(s)Required Permission(s)LinkDescription
POSTWS-AddSupportGroupintegration/api/odata/SupportGroups
DELETEWS-ModifySupportGroupintegration/api/odata/SupportGroups({key})
PATCHWS-ModifySupportGroupintegration/api/odata/SupportGroups({key})
POSTWS-ModifySupportGroupintegration/api/odata/SupportGroups({key})
GETWS-ReadSupportGroupintegration/api/odata/SupportGroups
GETWS-ReadSupportGroupintegration/api/odata/SupportGroups({key})

SupportGroups Actions

No actions

SupportGroups Functions

FunctionRequired Permission(s)LinkDescription
ListSupportGroupLinkedRecordsWS-ReadSupportGroupAssetMap,WS-ReadServerHostSupportGroupMap,WS-ReadBusinessApplicationSupportGroupMapintegration/api/odata/SupportGroups/ListSupportGroupLinkedRecords(SupportGroupID={supportgroupid})
GetWorkingHoursWS-ReadSupportGroupintegration/api/odata/SupportGroups/GetWorkingHours(AssigneeID={assigneeid})
GetNonWorkingDatesWS-ReadSupportGroupintegration/api/odata/SupportGroups/GetNonWorkingDates(AssigneeID={assigneeid})The function will return a collection of Nlyte.Model.ExclusionDate for support groups.
GetSupportGroupDescendantsWS-ReadSupportGroupintegration/api/odata/SupportGroups({key})/GetSupportGroupDescendants(IncludeSelf={includeself})Function returning a collection of Nlyte.Model.SupportGroup representing a tree of children for the selected group.
GetSupportGroupAscendantsAndSelfWS-ReadSupportGroupintegration/api/odata/SupportGroups({key})/GetSupportGroupAscendantsAndSelfFunction returning a collection of Nlyte.Model.SupportGroup representing a tree of parents for the selected group.

SupportGroups Custom Routes

CustomRouteRequired 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})/SupportGroupContactsWS-ReadSupportGroupResourceMap GET
integration/api/odata/SupportGroups({key})/SupportGroupContacts({relatedKey})WS-ReadSupportGroupResourceMap,WS-ReadResource GET
integration/api/odata/SupportGroups({key})/SupportGroupContactsWS-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

NestedPropertySupported Method(s)
AssociatedSupportGroups BIND POST PATCH
SupportGroupContacts BIND POST PATCH



TaskInstances Controller

Verb(s)Required Permission(s)LinkDescription
PUTWS-ModifyTaskintegration/api/odata/TaskInstances({key})
POSTintegration/api/odata/TaskInstances
POSTintegration/api/odata/TaskInstances({key})
PATCHWS-ModifyTaskintegration/api/odata/TaskInstances({key})
GETWS-ReadTaskintegration/api/odata/TaskInstances
GETWS-ReadTaskintegration/api/odata/TaskInstances({key})

TaskInstances Actions

ActionRequired Permission(s)LinkDescription
MoveAssetsWS-ExecuteMoveAssetsintegration/api/odata/TaskInstances({key})/MoveAssets(AssetIds={assetids})
RecycleAssetsWS-ExecuteRecycleAssetsintegration/api/odata/TaskInstances({key})/RecycleAssets(AssetIds={assetids})
DecommissionAssetsWS-ExecuteDecommissionAssetsintegration/api/odata/TaskInstances({key})/DecommissionAssets(AssetIds={assetids})
SetStatusWS-ModifyTaskintegration/api/odata/TaskInstances({key})/SetStatus(Status={status})
CreateAssetintegration/api/odata/TaskInstances({key})/CreateAsset(Asset={asset})
CreateAssetsWS-ExecuteCreateAssetsintegration/api/odata/TaskInstances({key})/CreateAssets(AssetRowIndexes={assetrowindexes})
RenameAssetsWS-ExecuteRenameAssetsintegration/api/odata/TaskInstances({key})/RenameAssets(AssetIds={assetids})
ModifyAssetsWS-ExecuteModifyAssetsintegration/api/odata/TaskInstances({key})/ModifyAssets(AssetIds={assetids})
CompleteAssetsWS-ExecuteCompleteAssetsintegration/api/odata/TaskInstances({key})/CompleteAssets(AssetIds={assetids})
UploadFileWS-AddFileintegration/api/odata/TaskInstances({key})/UploadFile(File={file})
DeleteFileWS-ModifyFileintegration/api/odata/TaskInstances({key})/DeleteFile(FileName={filename})

TaskInstances Functions

FunctionRequired Permission(s)LinkDescription
GetMyGroupsTasksWS-ReadTaskintegration/api/odata/TaskInstances/GetMyGroupsTasks
DownloadFileWS-ReadFileintegration/api/odata/TaskInstances({key})/DownloadFile(FileName={filename})
GetControlAssetsWS-ReadGetControlAssetsintegration/api/odata/TaskInstances({key})/GetControlAssets(formControlId={formcontrolid})

TaskInstances Custom Routes

CustomRouteRequired 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})/IssuesWS-ReadTask GET
integration/api/odata/TaskInstances({key})/IssuesWS-ModifyTask POST
integration/api/odata/TaskInstances({key})/Issues({relatedKey})/ResolveWS-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


TransformerAuxiliaryMaterials Controller

Verb(s)Required Permission(s)LinkDescription
POSTWS-AddAuxiliaryMaterialintegration/api/odata/TransformerAuxiliaryMaterials
PATCHWS-ModifyAuxiliaryMaterialintegration/api/odata/TransformerAuxiliaryMaterials({key})
DELETEWS-ModifyAuxiliaryMaterialintegration/api/odata/TransformerAuxiliaryMaterials({key})
GETWS-ReadAuxiliaryMaterialintegration/api/odata/TransformerAuxiliaryMaterials
GETWS-ReadAuxiliaryMaterialintegration/api/odata/TransformerAuxiliaryMaterials({key})

TransformerAuxiliaryMaterials Actions

ActionRequired Permission(s)LinkDescription
CancelWS-ModifyAuxiliaryMaterialintegration/api/odata/TransformerAuxiliaryMaterials({key})/Cancel
ActivateWS-ModifyAuxiliaryMaterialintegration/api/odata/TransformerAuxiliaryMaterials({key})/ActivateFunction that will move a material in Active status.
DeactivateWS-ModifyAuxiliaryMaterialintegration/api/odata/TransformerAuxiliaryMaterials({key})/DeactivateFunction that will move a material in Inactive status.
UploadFileWS-AddFileintegration/api/odata/TransformerAuxiliaryMaterials({key})/UploadFile(File={file})
DeleteFileWS-ModifyFileintegration/api/odata/TransformerAuxiliaryMaterials({key})/DeleteFile(FileName={filename})

TransformerAuxiliaryMaterials Functions

FunctionRequired Permission(s)LinkDescription
DownloadFileWS-ReadFileintegration/api/odata/TransformerAuxiliaryMaterials({key})/DownloadFile(FileName={filename})
GetAuditLogDataWS-ReadAuditLogintegration/api/odata/TransformerAuxiliaryMaterials({key})/GetAuditLogDataFunction 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

CustomRouteRequired 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


UPSMaterials Controller

Verb(s)Required Permission(s)LinkDescription
POSTWS-AddUPSMaterialintegration/api/odata/UPSMaterials
PATCHWS-ModifyUPSMaterialintegration/api/odata/UPSMaterials({key})
DELETEWS-ModifyUPSMaterialintegration/api/odata/UPSMaterials({key})
GETWS-ReadUPSMaterialintegration/api/odata/UPSMaterials
GETWS-ReadUPSMaterialintegration/api/odata/UPSMaterials({key})

UPSMaterials Actions

ActionRequired Permission(s)LinkDescription
CancelWS-ModifyUPSMaterialintegration/api/odata/UPSMaterials({key})/Cancel
ActivateWS-ModifyUPSMaterialintegration/api/odata/UPSMaterials({key})/ActivateFunction that will move a material in Active status.
DeactivateWS-ModifyUPSMaterialintegration/api/odata/UPSMaterials({key})/DeactivateFunction that will move a material in Inactive status.
UploadFileWS-AddFileintegration/api/odata/UPSMaterials({key})/UploadFile(File={file})
DeleteFileWS-ModifyFileintegration/api/odata/UPSMaterials({key})/DeleteFile(FileName={filename})

UPSMaterials Functions

FunctionRequired Permission(s)LinkDescription
DownloadFileWS-ReadFileintegration/api/odata/UPSMaterials({key})/DownloadFile(FileName={filename})
GetAuditLogDataWS-ReadAuditLogintegration/api/odata/UPSMaterials({key})/GetAuditLogDataFunction 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

CustomRouteRequired 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


UPSs Controller

Verb(s)Required Permission(s)LinkDescription
POSTWS-ModifyUPSintegration/api/odata/UPSs({key})
POSTWS-AddUPSintegration/api/odata/UPSs
PATCHWS-ModifyUPSintegration/api/odata/UPSs({key})
DELETEWS-ModifyUPSintegration/api/odata/UPSs({key})
GETWS-ReadUPSintegration/api/odata/UPSs
GETWS-ReadUPSintegration/api/odata/UPSs({key})

UPSs Actions

ActionRequired Permission(s)LinkDescription
BeginMoveWS-PlanRecycleUPS, WS-PlanDecommissionUPSintegration/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.
CancelMoveWS-CancelRecycleUPS, WS-CancelDecommissionUPSintegration/api/odata/UPSs({key})/CancelMoveFunction that is used to cancel planned action. The selected asset will become Active/Operational.
CompleteMoveWS-CompleteRecycleUPS, WS-CompleteDecommissionUPSintegration/api/odata/UPSs({key})/CompleteMoveFunction 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).
DirectMoveWS-SetLocationUPSintegration/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.
CompleteCreationWS-ModifyUPSintegration/api/odata/UPSs({key})/CompleteCreationFunction that moves an asset from Planned/(Pre)Procurement to Active/Operational.
SetMaterialintegration/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.
AddRealTimeValuesWS-AddAssetRealtimeDataintegration/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.
AddNetworkAssetWS-ReadNetworkConnection,WS-AddNetworkConnectionintegration/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.
RemoveNetworkAssetWS-ModifyNetworkConnectionintegration/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.
UploadFileWS-AddFileintegration/api/odata/UPSs({key})/UploadFile(File={file})
DeleteFileWS-ModifyFileintegration/api/odata/UPSs({key})/DeleteFile(FileName={filename})

UPSs Functions

FunctionRequired Permission(s)LinkDescription
GetTotalSystemPowerConsumptionWS-ReadUPSintegration/api/odata/UPSs({key})/GetTotalSystemPowerConsumptionFunction that returns the TotalSystemPowerConsumption for the selected asset.
GetRealTimePowerInfoWS-ReadUPSintegration/api/odata/UPSs({key})/GetRealTimePowerInfo
GetDiscoveryAssetPageWS-ReadUPSintegration/api/odata/UPSs({key})/GetDiscoveryAssetPageFunction that returns a collection of entities of type Nlyte.Model.AssetMapping. Used to determine external providers.
RecordModifiedInfoWS-ReadUPSintegration/api/odata/UPSs({key})/RecordModifiedInfoFunction that returns an entity of type Nlyte.Model.AuditLogInfo and provides information regarding last modifications against the current asset
GetMountedChildAssetsintegration/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.
GetDistributorsWithFreeOutletsWS-ReadAssetToAssetMappingintegration/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.
SearchAssetNetworkPortLinkageWS-ReadNetworkConnectionintegration/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.
GetRealTimeValuesWS-ReadAssetRealtimeDataintegration/api/odata/UPSs({key})/GetRealTimeValuesFunction that returns a collection of entities of type Nlyte.Model.RealTimeValue.
GetAssetSummariesintegration/api/odata/UPSs({key})/GetAssetSummaries(OwnedPeripherals={ownedperipherals}, IncludeHosts={includehosts})
GetNetworkCardPortsInfoWS-ReadNetworkConnectionintegration/api/odata/UPSs({key})/GetNetworkCardPortsInfoReturns an object of type Nlyte.Model.NetworkResults having information about Copper and Fiber Ports
GetNetworkCardPortConnectionsWS-ReadNetworkConnectionintegration/api/odata/UPSs({key})/GetNetworkCardPortConnectionsReturns an object of type Nlyte.Model.NetworkResults having information about Copper and Fiber Port connections
GetNetworkAssetSummaryWS-ReadNetworkConnectionintegration/api/odata/UPSs({key})/GetNetworkAssetSummaryReturns an object of type Nlyte.Model.NetworkResults having information about the networkable assets.
ListPowerConsumersintegration/api/odata/UPSs({key})/ListPowerConsumersFunction that returns a collection of Nlyte.Model.Graph entities. Used to identify available Output Connector used in power connections.
SupportsPlannedMoveintegration/api/odata/UPSs({key})/SupportsPlannedMove
GetTotalSystemWeightintegration/api/odata/UPSs({key})/GetTotalSystemWeightFunction that returns the TotalSystemWeight for the selected asset.
GetMountedOnAssetIDintegration/api/odata/UPSs({key})/GetMountedOnAssetID
GetAssetsReportDataWS-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-ReadServerHostintegration/api/odata/UPSs/GetAssetsReportData(assetIds={assetids})
DownloadFileWS-ReadFileintegration/api/odata/UPSs({key})/DownloadFile(FileName={filename})
GetAuditLogDataWS-ReadAuditLogintegration/api/odata/UPSs({key})/GetAuditLogDataFunction 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

CustomRouteRequired 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})/CustomFieldsWS-ReadCustomFieldUPS GET
integration/api/odata/UPSs({key})/CustomFieldsWS-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})/WarrantyWS-ReadUPS GET
integration/api/odata/UPSs({key})/WarrantyWS-ModifyUPS POST
integration/api/odata/UPSs({key})/WarrantyWS-ModifyUPS PATCH
integration/api/odata/UPSs({key})/WarrantyWS-ModifyUPS DELETE
integration/api/odata/UPSs({key})/MaintenanceWS-ReadUPS GET
integration/api/odata/UPSs({key})/MaintenanceWS-ModifyUPS POST
integration/api/odata/UPSs({key})/MaintenanceWS-ModifyUPS PATCH
integration/api/odata/UPSs({key})/MaintenanceWS-ModifyUPS DELETE
integration/api/odata/UPSs({key})/AssetMounting GET
integration/api/odata/UPSs({key})/OwnershipWS-ReadBusinessGroupAssetMap GET
integration/api/odata/UPSs({key})/Ownership({relatedKey})WS-ReadBusinessGroupAssetMap GET
integration/api/odata/UPSs({key})/OwnershipWS-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})/SupportWS-ReadSupportGroupAssetMap GET
integration/api/odata/UPSs({key})/Support({relatedKey})WS-ReadSupportGroupAssetMap GET
integration/api/odata/UPSs({key})/SupportWS-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

NestedPropertySupported 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



UserAccountPermissions Controller

Verb(s)Required Permission(s)LinkDescription
GETintegration/api/odata/UserAccountPermissions
GETintegration/api/odata/UserAccountPermissions({key})

UserAccountPermissions Actions

No actions

UserAccountPermissions Functions

No functions

UserAccountPermissions Custom Routes

CustomRouteRequired 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


UserAccounts Controller

Verb(s)Required Permission(s)LinkDescription
GETintegration/api/odata/UserAccountsReturns user account data for currently-logged-in user
GETintegration/api/odata/UserAccounts({key})

UserAccounts Actions

No actions

UserAccounts Functions

No functions

UserAccounts Custom Routes

CustomRouteRequired 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


UserEffectivePermissions Controller

Verb(s)Required Permission(s)LinkDescription
GETintegration/api/odata/UserEffectivePermissions
GETintegration/api/odata/UserEffectivePermissions({key})

UserEffectivePermissions Actions

No actions

UserEffectivePermissions Functions

No functions

UserEffectivePermissions Custom Routes

No custom routes

UserEffectivePermissions Nested Properties

No nested properties


UserGroupPermissions Controller

Verb(s)Required Permission(s)LinkDescription
GETintegration/api/odata/UserGroupPermissions
GETintegration/api/odata/UserGroupPermissions({key})

UserGroupPermissions Actions

No actions

UserGroupPermissions Functions

No functions

UserGroupPermissions Custom Routes

CustomRouteRequired 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


Utilities Controller

Verb(s)Required Permission(s)LinkDescription
GETWS-ReadUtilityintegration/api/odata/Utilities
GETWS-ReadUtilityintegration/api/odata/Utilities({key})

Utilities Actions

No actions

Utilities Functions

No functions

Utilities Custom Routes

CustomRouteRequired 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


WorkingHours Controller

Verb(s)Required Permission(s)LinkDescription
DELETEintegration/api/odata/WorkingHours({key})
POSTintegration/api/odata/WorkingHours
POSTintegration/api/odata/WorkingHours({key})
PATCHintegration/api/odata/WorkingHours({key})
GETintegration/api/odata/WorkingHours
GETintegration/api/odata/WorkingHours({key})

WorkingHours Actions

No actions

WorkingHours Functions

No functions

WorkingHours Custom Routes

CustomRouteRequired 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

AllocateCriteria - Allocation criteria values defined for an asset

PropertyTypeNullableRead-OnlyDescription
ActiveForeignProjectIDEdm.Int32false false
ActiveForeignProjectNameEdm.String true false
AirflowTypeIDNlyte.Model.AirflowTypeEnum true false Selected air flow, from the available values defined in the administration area
AllocatedCabinetAssetIDEdm.Int32false false
AllocatedCabinetAssetNumberEdm.Int32false false
AllocatedCabinetNameEdm.String true false
AllocatedDuplicateLocationGroupNameEdm.String true false The unique location name, having the name as a concatenation of last hierarchical location names.
AllocatedLocationGroupIDEdm.Int32false false Foreign key identifying the new location after allocation
AllocatedUEdm.Int32false false
AssetIDEdm.Int32false false
BusinessGroupIDEdm.Int32 true false
CabinetUsageIDEdm.Int32 true false
CardConnectionsRequiredEdm.Booleanfalse false
CompatibleNetworksRequiredEdm.Booleanfalse false
ConnectCardConnectionsEdm.Booleanfalse false
ConnectKvmEdm.Booleanfalse false
ConnectPowerConnectionsEdm.Booleanfalse false
CurrentCabinetAssetIDEdm.Int32false false
CurrentCabinetAssetNumberEdm.Int32false false
CurrentCabinetNameEdm.String true false
CurrentDuplicateLocationGroupNameEdm.String true false The unique current location name, having the name as a concatenation of last hierarchical location names
CurrentLocationGroupIDEdm.Int32false false Foreign key identifying the current location of the asset planned to allocation.
DataTypeRequiredEdm.Booleanfalse false
DiversePowerRequiredEdm.Booleanfalse false
ErrorsCollection(Edm.String) true false
FindExactMatchForUSpaceEdm.Booleanfalse false
IDEdm.Int32false false
IncludeInAutoAllocationEdm.Booleanfalse false
KvmSwitchRequiredEdm.Booleanfalse false
MaterialNameEdm.String true false
MaterialNumberEdm.Int32false false
MaterialSubTypeIDEdm.Int32false false
MaterialTypeIDEdm.Int32false false
MaterialTypeNameEdm.String true false
MaterialUheightEdm.Int32false false
MountingTypeIDNlyte.Model.MountingTypeEnum true false
NameEdm.String true false
NumberEdm.Int32false false
OrderEdm.Int32false false
PatchingNetworkSubTypeIDNlyte.Model.NetworkSubTypeEnum true false Selected network sub-type used in search during AutoAllocate for network patching. Default = PatchPanel
PlannedAssetIDEdm.Int32false false
PlannedNameEdm.String true false
PlannedNumberEdm.Int32false false
PowerConnectionsRequiredEdm.Booleanfalse false
ProjectItemActionIDNlyte.Model.ProjectItemActionEnumfalse false
ProjectItemHistoryIDEdm.Int32 true false
ProjectItemStatusIDNlyte.Model.ProjectItemStatusEnum true false
ProjectItemTypeIDEdm.Int32false false
RequiredUHeightEdm.Int32false false
ReturnCabinetsLinkedToSelectedBusinessGroupOnlyEdm.Booleanfalse false
StatusIDEdm.Int32false false
TargetDuplicateLocationGroupNameEdm.String true false The unique planned location name, having the name as a concatenation of last hierarchical location names.
TargetLocationGroupIDEdm.Int32false false Foreign key identifying the planned location in which the asset will be allocated
TargetLocationGroupNameEdm.String true false The planned location name
TotalHeatEdm.Decimalfalse false
TotalUheightEdm.Int32false false
TotalWeightEdm.Doublefalse false
UseAirflowEdm.Booleanfalse false
UseBusinessGroupsEdm.Booleanfalse false
UseCabinetUsageEdm.Booleanfalse false
UseCardConnectionsEdm.Booleanfalse false
UseCompatibleNetworksEdm.Booleanfalse false
UseDataTypeEdm.Booleanfalse false
UseDiversePowerEdm.Booleanfalse false
UseKvmSwitchEdm.Booleanfalse false
UseMountingTypeEdm.Booleanfalse false
UsePatchingNetworkSubTypeEdm.Booleanfalse false
UsePowerConnectionsEdm.Booleanfalse false
UseTotalHeatEdm.Booleanfalse false
UseTotalWeightEdm.Booleanfalse false
UseWarningPoliciesEdm.Booleanfalse false
WarningsCollection(Edm.String) true false



AssetActivityResponse

PropertyTypeNullableRead-OnlyDescription
AssetMapsCollection(Nlyte.Model.AssetMap) true false
TaskInstanceIDEdm.Int32false false



AssetAllocationCriteria - Entity providing details about allocation criteria values

PropertyTypeNullableRead-OnlyDescription
AirFlowTypeIdNlyte.Model.AirflowTypeEnum true false Selected air flow, from the available values defined in the administration area
MountingTypeIdNlyte.Model.MountingTypeEnum true false
RequiresDiversePowerEdm.Booleanfalse false
RequiresKvmSwitchEdm.Booleanfalse false
RequiresPatchConnectionsEdm.Booleanfalse false
RequiresPortDataTypeConnectionsEdm.Booleanfalse false
TotalUSpaceRequiredEdm.Int32false false
UseCardConnectionsEdm.Booleanfalse false
UsePatchingNetworkSubTypeEdm.Booleanfalse false



AssetMap

PropertyTypeNullableRead-OnlyDescription
ActiveAssetIdEdm.Int32false false
PlannedAssetIdEdm.Int32 true false



AssetNetworkPortLinkage

PropertyTypeNullableRead-OnlyDescription
CabinetAssetNameEdm.String true false
DuplicateLocationGroupNameEdm.String true false The unique location name, having the name as a concatenation of last hierarchical location names.
FreeCopperPortsEdm.Int32 true false
FreeFibreOpticPortsEdm.Int32 true false
FreeUndefinedPortsEdm.Int32 true false
LocationGroupIDEdm.Int32 true false Foreign key identifying the asset location
LocationGroupNameEdm.String true false The location name
MaterialNameEdm.String true false
MountingTypeEdm.String true false
MountingTypeIDEdm.Int32 true false
NetworkAssetIDEdm.Int32false false
NetworkAssetNameEdm.String true false
NetworkAssetNumberEdm.Int32false false
NetworkSpeedMbpsEdm.Int32 true false Network speed in Mbps
NetworkTypeIDEdm.Int32 true false
OperationalStatusIDEdm.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.
RecordStatusEdm.Int32 true false
RecordStatusDescriptionEdm.String true false
TotalCopperPortsEdm.Int32 true false
TotalFibreOpticPortsEdm.Int32 true false
TotalUndefinedPortsEdm.Int32 true false



AssetOverlay

PropertyTypeNullableRead-OnlyDescription
AssetIDEdm.Int32false false
ColourEdm.String true false
ValueEdm.String true false



AssetProperties

PropertyTypeNullableRead-OnlyDescription
IDEdm.String true false
PropertiesCollection(Nlyte.Model.NameValue) true false



AssetSummary

PropertyTypeNullableRead-OnlyDescription
AssetIDEdm.Int32 true false
AssetNameEdm.String true false
AssetNumberEdm.Int32 true false
AssetTypeDetailEdm.Stringfalse false
CabinetUsageIDEdm.Int32 true false
CustomFieldCollection(Nlyte.Model.KeyValuePair_2OfString_String) true false
FunctionalUseIDEdm.Int32 true false
HeatingLimitEdm.Doublefalse false
HeatThresholdEdm.Doublefalse false
LocationGroupIDEdm.Int32false false
MaterialNameEdm.Stringfalse false
MaterialNumberEdm.Int32 true false
MaterialSubTypeIDEdm.Int32 true false
MaterialTypeIDEdm.Int32false false
OperationalStatusNlyte.Model.OperationalStatusEnumfalse false
OperationalUseIDEdm.Int32 true false
ParentAssetIDEdm.Int32 true false
PONumberEdm.String true false
PRNumberEdm.String true false
RecordStatusNlyte.Model.RecordStatusEnumfalse false
RFIDTagEdm.String true false Damaged RFIDTag
SAPAssetNumberEdm.String true false
SerialNumberEdm.String true false
TagEdm.String true false



AutoAllocateSearchResult - Represents a cabinet that was found after the allocation process, that satisfies the allocation criteria

PropertyTypeNullableRead-OnlyDescription
AirflowTypeNlyte.Model.AirflowTypeEnumfalse false
AssetNameEdm.String true false The cabinet asset name
AvailableUHeightEdm.String true false
CabinetAssetIdEdm.Int32false false
CabinetUsageIdEdm.Int32false false
DuplicateLocationGroupNameEdm.String true false The unique location name, having the name as a concatenation of last hierarchical location names.
HeatThresholdEdm.Doublefalse false
LocationGroupIdEdm.Int32false false Foreign key identifying the location
MaterialIdEdm.Int32false false The key that identifies the material from which the cabinet for auto-allocation was created.
MountingTypeNlyte.Model.MountingTypeEnumfalse false
RankEdm.Int32false false
RemainingCoolingEdm.Doublefalse false
TotalHeatUsageEdm.Doublefalse false



AutoAllocationMessage

PropertyTypeNullableRead-OnlyDescription
MessageCodeEdm.String true false
ResultEdm.Booleanfalse false



ByteArrayContent

PropertyTypeNullableRead-OnlyDescription



ByteRangeStreamContent

PropertyTypeNullableRead-OnlyDescription



ChangeSetResponseItem

PropertyTypeNullableRead-OnlyDescription
ResponsesCollection(Nlyte.Model.HttpResponseMessage) true false



ChassisMountableAsset

PropertyTypeNullableRead-OnlyDescription
AssetIDEdm.Int32false false
AssetNameEdm.String true false
AssetNumberEdm.Int32false false
CabinetAssetIDEdm.Int32 true false
CabinetAssetNameEdm.String true false
ChassisAssetIDEdm.Int32 true false
ChassisAssetNameEdm.String true false
ColumnsEdm.Int32false false
DuplicateLocationGroupNameEdm.String true false The unique location name, having the name as a concatenation of last hierarchical location names.
LocationGroupIDEdm.Int32false false Foreign key identifying the asset location
OperationalStatusNlyte.Model.OperationalStatusEnumfalse false Reflects the current state and/or planned future state. Together with the Record Status, they give the user the exact life-cycle status.
RecordStatusNlyte.Model.RecordStatusEnumfalse false
RowsEdm.Int32false false



ChassisWithFreeSlots - Entity providing summary details about a chassis that can be used for mounting

PropertyTypeNullableRead-OnlyDescription
CabinetAssetIDEdm.Int32 true false
CabinetAssetNameEdm.String true false
ChassisAssetIDEdm.Int32false false
ChassisAssetNameEdm.String true false
ChassisAssetNumberEdm.Int32false false
DuplicateLocationGroupNameEdm.String true false The unique location name, having the name as a concatenation of last hierarchical location names.
FreeSlotsEdm.Int32false false
LocationGroupIDEdm.Int32false false Foreign key identifying the asset location
MaterialIDEdm.Int32false false The key that identifies the material from which the asset was created.
MaterialNameEdm.String true false
OperationalStatusNlyte.Model.OperationalStatusEnumfalse false Reflects the current state and/or planned future state. Together with the Record Status, they give the user the exact life-cycle status.
RecordStatusNlyte.Model.RecordStatusEnumfalse false



ComboBoxControlItem

PropertyTypeNullableRead-OnlyDescription
IdEdm.Int32false false
ItemsCollection(Nlyte.Model.ComboBoxControlNestedItem) true false
LabelEdm.String true false



ComboBoxControlNestedItem

PropertyTypeNullableRead-OnlyDescription
IdEdm.Int32false false
ItemsCollection(Nlyte.Model.ComboBoxControlItem) true false
LabelEdm.String true false



ControlValueSummary

PropertyTypeNullableRead-OnlyDescription
IdEdm.Int32false false
ValueEdm.String true false



Distributor - Entity providing summary details about a power distributor asset and its availability

PropertyTypeNullableRead-OnlyDescription
AssetIDEdm.Int32false false
AssetNameEdm.String true false
AssetNumberEdm.Int32false false
AvailableOutputsEdm.Int32false false
CabinetAssetIdEdm.Int32 true false
CabinetAssetNameEdm.String true false
DuplicateLocationGroupNameEdm.String true false The unique location name, having the name as a concatenation of last hierarchical location names.
LocationGroupIDEdm.Int32false false Foreign key identifying the asset location
MaterialIDEdm.Int32false false
MaterialNameEdm.String true false
MaterialSubTypeIDEdm.Int32false false
MaterialTypeIDEdm.Int32false false
OperationalStatusNlyte.Model.OperationalStatusEnumfalse false
RecordStatusNlyte.Model.RecordStatusEnumfalse false
SupplierAssetCountEdm.Int32 true false
SupplierAssetNameEdm.String true false
SupplierIsAccessibleEdm.Int32 true false
SupplierMaterialTypeEdm.Int32 true false
SupplierMaterialTypeNameEdm.String true false
SupplierMaterialTypesCountEdm.Int32 true false
TotalOutputsEdm.Int32false false



ExpectedODataError

PropertyTypeNullableRead-OnlyDescription
errorNlyte.Model.ODataErrorfalse false



ExpectedODataErrorBase

PropertyTypeNullableRead-OnlyDescription
codeEdm.String true false
messageEdm.String true false



ExpectedODataErrorDetails

PropertyTypeNullableRead-OnlyDescription
detailsCollection(Nlyte.Model.ExpectedODataErrorBase)false false



FormUrlEncodedContent

PropertyTypeNullableRead-OnlyDescription



HttpContent

PropertyTypeNullableRead-OnlyDescription
HeadersCollection(Nlyte.Model.KeyValuePair_2OfString_IEnumerable_1OfString) true false



HttpMessageContent

PropertyTypeNullableRead-OnlyDescription



HttpMethod

PropertyTypeNullableRead-OnlyDescription



HttpRequestMessage

PropertyTypeNullableRead-OnlyDescription
ContentNlyte.Model.HttpContent true false
HeadersCollection(Nlyte.Model.KeyValuePair_2OfString_IEnumerable_1OfString) true false
MethodNlyte.Model.HttpMethod true false
RequestUriNlyte.Model.Uri true false
VersionNlyte.Model.Version true false



HttpResponseMessage

PropertyTypeNullableRead-OnlyDescription
ContentNlyte.Model.HttpContent true false
HeadersCollection(Nlyte.Model.KeyValuePair_2OfString_IEnumerable_1OfString) true false
ReasonPhraseEdm.String true false
RequestMessageNlyte.Model.HttpRequestMessage true false
StatusCodeSystem.Net.HttpStatusCodefalse false
VersionNlyte.Model.Version true false



KeyValue

PropertyTypeNullableRead-OnlyDescription
KeyEdm.Int32false false
ValueEdm.String true false



KeyValuePair_2OfString_IEnumerable_1OfString

PropertyTypeNullableRead-OnlyDescription
ValueCollection(Edm.String) true false



KeyValuePair_2OfString_String

PropertyTypeNullableRead-OnlyDescription



LinkedRecordsSummary

PropertyTypeNullableRead-OnlyDescription
LinkedRecordCountEdm.Int32false false
MaterialTypeIdEdm.Int32false false
MaterialTypeNameEdm.String true false



MountedAssetSummary - Entity representing a mountable asset, in a cabinet or chassis

PropertyTypeNullableRead-OnlyDescription
AssetIdEdm.Int32false false
AssetNameEdm.String true false
AssetNumberEdm.Int32false false
CabinetAssetIdEdm.Int32 true false Foreign key identifying the asset of type cabinet, in which the current asset is mounted..
CabinetAssetNameEdm.String true false
CabinetMountingSideIdEdm.Int32 true false
CabinetOrientationIdEdm.Int32 true false
CabinetPlacementIdEdm.Int32 true false
CabinetUEdm.Int32 true false Property providing the cabinet U details.
ChassisMountingSideIdEdm.Int32 true false
ChassisSlotColumnEdm.Int32 true false
ChassisSlotRowEdm.Int32 true false
HasChildrenEdm.Booleanfalse false
LocationGroupIdEdm.Int32 true false Foreign key identifying the asset location
LowerCabinetUEdm.Int32 true false The bottom U position in which the asset is mounted.
MaterialIdEdm.Int32 true false The key that identifies the material from which the asset was created.
MaterialNameEdm.String true false
MaterialSubTypeIdEdm.Int32 true false Each material type has its own sub-types, to properly identify the material and the asset created from the material.
MaterialTypeIdEdm.Int32false 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.
OperationalStatusNlyte.Model.OperationalStatusEnumfalse false
PoNumberEdm.String true false
PowerStateIdEdm.Boolean true false
PrNumberEdm.String true false PR Number
RecordStatusNlyte.Model.RecordStatusEnumfalse false
RfidTagEdm.String true false RFID Tag
SapAssetNumberEdm.String true false
SerialNumberEdm.String true false
TagEdm.String true false
UDisplayLabelEdm.Int32 true false The U label to be displayed, representing the top or the bottom U position, depending on the admin parameter



MultipartContent

PropertyTypeNullableRead-OnlyDescription



MultipartFormDataContent

PropertyTypeNullableRead-OnlyDescription



NameValue

PropertyTypeNullableRead-OnlyDescription
KeyEdm.String true false
ValueEdm.String true false



NetworkResult

PropertyTypeNullableRead-OnlyDescription
PropertiesCollection(Nlyte.Model.AssetProperties) true false



NetworkResults

PropertyTypeNullableRead-OnlyDescription
CopperResultsCollection(Nlyte.Model.NetworkResult) true false
FiberResultsCollection(Nlyte.Model.NetworkResult) true false



ObjectContent

PropertyTypeNullableRead-OnlyDescription



ObjectContent_1OfT

PropertyTypeNullableRead-OnlyDescription



ODataBatchContent

PropertyTypeNullableRead-OnlyDescription
ResponsesCollection(Nlyte.Model.ODataBatchResponseItem) true false



ODataBatchResponseItem

PropertyTypeNullableRead-OnlyDescription



ODataError

PropertyTypeNullableRead-OnlyDescription
codeEdm.String true false
detailsCollection(Nlyte.Model.ODataErrorDetail)false false
messageEdm.String true false



ODataErrorDetail

PropertyTypeNullableRead-OnlyDescription
codeEdm.String true false
messageEdm.String true false



OperationResponseItem

PropertyTypeNullableRead-OnlyDescription



ProjectAssetSearchResult - Provides a summary an available item that can be added to a project

PropertyTypeNullableRead-OnlyDescription
CanAutoAllocateEdm.Booleanfalse false
CanCreateEdm.Booleanfalse false
CanDecommissionEdm.Booleanfalse false
CanDuplicateEdm.Booleanfalse false
IdEdm.Int32false false
LocationGroupIdEdm.Int32false false Foreign key identifying the project location
LocationGroupNameEdm.String true false The location name
MaterialNameEdm.String true false
MaterialTypeIdEdm.Int32false false
NameEdm.String true false
NumberEdm.Int32false false
OperationalStatusIdEdm.Int32false 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.
RecordStatusIdEdm.Int32false false



ProjectExecutionHistorySummary - Item providing details about the allocation execution history

PropertyTypeNullableRead-OnlyDescription
ActionIdNlyte.Model.ProjectJobActionfalse false
IsProcessingEdm.Booleanfalse false
ItemHistoryCollection(Nlyte.Model.ProjectItemHistorySummary) true false A collection of entities providing details about the allocation history per item
JobCompletedCountEdm.Int32false false
JobSizeEdm.Int32false false



ProjectGanttItem - Entity providing a summary of the project

PropertyTypeNullableRead-OnlyDescription
ActualEndDateEdm.DateTimeOffset true false
ActualStartDateEdm.DateTimeOffset true false
CreationDateEdm.DateTimeOffsetfalse false
ExpectedEndDateEdm.DateTimeOffset true false
ExpectedStartDateEdm.DateTimeOffset true false
IdEdm.Int32false false
NameEdm.String true false
NumberEdm.Int32false false
NumberOfAllocatedItemsEdm.Int32false false
NumberOfCompletedItemsEdm.Int32false false
StatusIdEdm.Int32false false
TotalNumberOfItemsEdm.Int32false false
TypeIdEdm.Int32false false Project type: allocation or forecast



ProjectItemHistorySummary - Entity providing details about the allocation history per item

PropertyTypeNullableRead-OnlyDescription
AllocatedCabinetAssetIdEdm.Int32false false
AllocatedCabinetAssetNumberEdm.Int32false false
AllocatedCabinetNameEdm.String true false
AllocatedLocationGroupIdEdm.Int32false false Foreign key identifying the location
AllocatedUEdm.Int32false false
ErrorsCollection(Edm.String) true false
IdEdm.Int32false false
ItemStatusIdEdm.Int32false false
PlannedNameEdm.String true false
PlannedNumberEdm.Int32false false
ProjectItemIdEdm.Int32false false
StatusIdEdm.Int32false false
WarningsCollection(Edm.String) true false



ProjectItemSummary - Entity providing details about the item associated to a project

PropertyTypeNullableRead-OnlyDescription
ActionIDEdm.Int32false false
ActionNameNlyte.Model.ProjectItemActionEnumfalse false Describes the purpose of the item
AssetIDEdm.Int32false false
ChassisMountedAssetCountEdm.Int32false false
HasRelatedAssetsEdm.Booleanfalse false
HostCountEdm.Int32false false
IsHostEdm.Booleanfalse false
IsLeafEdm.Booleanfalse false
ItemNameEdm.String true false
ItemNumberEdm.Int32false false
LocationGroupIDEdm.Int32 true false Foreign key identifying the project location
ManufacturerIDEdm.Int32 true false The manufacturer ID, used from the predefined list of manufacturers, defined for the asset associated to the current project
MaterialIDEdm.Int32false false The key that identifies the material from which the asset/project item was created.
MaterialNameEdm.String true false
MaterialNumberEdm.Int32false false
MaterialSubTypeIDEdm.Int32false false
MaterialTypeEdm.String true false
MaterialTypeIDEdm.Int32false false
NumberOfCopiesEdm.Int32false false
OperationalStatusIDEdm.Int32 true false
OperationIDEdm.Int32false false
OrderEdm.Int32false false
OwnedPeripheralCountEdm.Int32false false
OwnerAssetIDEdm.Int32false false
ProjectItemIDEdm.Int32false false
RecordStatusIDEdm.Int32false false



PushStreamContent

PropertyTypeNullableRead-OnlyDescription



ReportColour

PropertyTypeNullableRead-OnlyDescription
IDEdm.Int32 true false
LabelEdm.String true false
ResultEdm.Int32false false
ValueEdm.String true false



ReportColourScheme

PropertyTypeNullableRead-OnlyDescription
ColoursCollection(Nlyte.Model.ReportColour) true false
IDEdm.Int32false false
LabelEdm.String true false



Result

PropertyTypeNullableRead-OnlyDescription



ResultIds

PropertyTypeNullableRead-OnlyDescription
NewIdEdm.Int32false false
OldIdEdm.Int32false false



StreamContent

PropertyTypeNullableRead-OnlyDescription



StringContent

PropertyTypeNullableRead-OnlyDescription



TemplateAssetSummary

PropertyTypeNullableRead-OnlyDescription
TypeNameEdm.String true false



UnplacedAsset

PropertyTypeNullableRead-OnlyDescription
AssetIDEdm.Int32false false
AssetNameEdm.String true false
AssetNumberEdm.Int32false false
ExternalDepthEdm.Doublefalse false
ExternalWidthEdm.Doublefalse false
HasRoomItemEdm.Booleanfalse false
HeatingLimitEdm.Double true false
HeatThresholdEdm.Double true false
LocationGroupIDEdm.Int32false false
LocationGroupNameEdm.String true false The location name
MaterialSubtypeEdm.String true false
MaterialSubtypeIDEdm.Int32false false
MaterialTypeEdm.String true false
MaterialTypeIDEdm.Int32false false
OperationalStatusNlyte.Model.OperationalStatusEnumfalse false
RecordStatusNlyte.Model.RecordStatusEnumfalse false
WeightLimitEdm.Double true false
WeightMaximumEdm.Double true false
WeightThresholdEdm.Double true false



Uri

PropertyTypeNullableRead-OnlyDescription
SegmentsCollection(Edm.String) true false



Version

PropertyTypeNullableRead-OnlyDescription






Enumerations

AirConditioningFlowDirectionEnum

NameValue
DownFlow1
UpFlow2
Ambient3
DuctedDownFlow4
DuctedUpFlow5



AirflowTypeEnum

NameValue
FrontToBack1
BackToFront2
BottomToTop3
TopToBottom4
LeftToRight5
RightToLeft6
Ambient7
WaterCooled8



AreaType

NameValue
Area1
Pod2
Cage3
Container4
Module5
Zone6



AssetTemplateJobStatus

NameValue
Complete0
InProgress1
Error2
Canceled3



AssetTemplateJobType

NameValue
Creation0
Instantiation1
Copy2



AssetTemplateStatus

NameValue
New0
Active1
Inactive2



AssetTemplateType

NameValue
Asset1
FloorStandingAssets2



AssetTypeEnum

NameValue
Asset1
Host2



AssetUploaderJobStatus

NameValue
InQueue0
InProgress1
Completed2
Error3
Cancelled4
Deleted5
CancelRequested6
InQueueAllocated7
CancelRequestAllocated8



AssigneeType

NameValue
BusinessGroup0
SupportGroup1
Resource2



BusinessApplicationRecordStatus

NameValue
Active1
Cancelled2



CabinetDoorTypeEnum

NameValue
Glass1
Acrylic2
Vented3
NonVented4
None5



CabinetLockTypeEnum

NameValue
KeyBarrel1
CodeKey2
SwipeCard3
None4



CabinetMapResourceType

NameValue
Power1
Network2
PowerAndNetwork3



CabinetMountingStatus

NameValue
SameCabinet1
Mounted2
NotMounted3



CabinetPositionEnum

NameValue
CeilingCenter1
UpperLeft2
UpperRight3
CenterLeft4
CenterRight5
LowerLeft6
LowerRight7
Floor8
BelowFloorCenter9
BelowFloorLeft10
BelowFloorRight11
CeilingLeft12
CeilingRight13
FloorLeft14
FloorRight15
NotApplicable16



CabinetUOrderEnum

NameValue
Ascending1
Descending2



CabinetUStateEnum

NameValue
Full0
Free1



ChassisMountingStrategy

NameValue
FirstSlotAvailable10
ScratchPad20



ChassisMountingValidationResult

NameValue
Valid0
AssetNotPresent10
PowerConsumptionExceded20



ConnectionTypeEnum

NameValue
Network1
PowerSupplier2
PowerConsumer4



CreateAssetMaterialType

NameValue
NotSet0
Server1
PDU2
Powerstrip3
Cabinet4
Network5
Peripheral6
KVMSwitch7
AirConditioning8
Receptacle9
Chassis53
Auxiliary54
StaticSwitch56
Ups57
Host99
ChassisMountedAsset777



CustomRuleOperandType

NameValue
TYPE_BASIC0
TYPE_ASSIGNEE1
TYPE_COMBOBOX_ITEM2
TYPE_DATE3
TYPE_INTEGRATION_COMBOBOX_ITEM4
TYPE_LOCATION5
TYPE_FIELD_PICKER6



DependencyType

NameValue
None0
AnyValue1
CustomValue2



EditAssetTypeEnum

NameValue
None0
Create1
Edit2



FieldPickerEntityType

NameValue
None0
Material1
Location2
BusinessGroup3
SupportGroup4
Software5
ChassisMountedAsset6
SQLView7



FileEntityType

NameValue
ServiceRequest1
TaskInstance2
Asset3
Material4
Host5
Software6



FillType

NameValue
Solid0
Vertical111
Vertical212
Vertical313
Vertical414
Horizontal121
Horizontal222
Horizontal323
Horizontal424
Diagonal131
Diagonal232
Diagonal333
Diagonal434
Check141
Check242
Check343
Check444
DiagonalCheck151
DiagonalCheck252
DiagonalCheck353
DiagonalCheck454



FloorPlannerMaterial

NameValue
Concrete1
Plaster2
Wood3



FormControlType

NameValue
TextInput1
TextArea2
ComboBox3
CheckBox4
Label5
DatePicker6
UrlLink7
CascadingForm9
EquipmentPicker10
BusinessApplicationPicker11
FieldPicker12
RenameAssetControl13
RecycleAssetControl14
MoveAssetControl15
CreateAssetControl16
CompleteActivityControl17
EditAssetControl18
DecommissionAssetControl19



FormStatus

NameValue
New0
Draft1
OnHold2
Archived3
Published4



GroupType

NameValue
BusinessGroup0
SupportGroup1



HostMoveOperationsEnum

NameValue
None0
Begin1
Cancel2
Move3
Complete4



HttpAction

NameValue
Get0
Post1
PostWithKey2
Patch3
Delete4
Put5



HttpStatusCode

NameValue
Continue100
SwitchingProtocols101
OK200
Created201
Accepted202
NonAuthoritativeInformation203
NoContent204
ResetContent205
PartialContent206
MultipleChoices300
MovedPermanently301
Redirect302
SeeOther303
NotModified304
UseProxy305
Unused306
TemporaryRedirect307
BadRequest400
Unauthorized401
PaymentRequired402
Forbidden403
NotFound404
MethodNotAllowed405
NotAcceptable406
ProxyAuthenticationRequired407
RequestTimeout408
Conflict409
Gone410
LengthRequired411
PreconditionFailed412
RequestEntityTooLarge413
RequestUriTooLong414
UnsupportedMediaType415
RequestedRangeNotSatisfiable416
ExpectationFailed417
UpgradeRequired426
InternalServerError500
NotImplemented501
BadGateway502
ServiceUnavailable503
GatewayTimeout504
HttpVersionNotSupported505



ImageFileType

NameValue
Jpg1
Png2
Svg3
Tiff4
Bmp5
Gif6



IntegrationTagCategory

NameValue



IntegrationTagType

NameValue
Text1
Selection2



IssueType

NameValue
CabinetWeightLimit1
ShelfWeightLimit2



IssueTypeWf

NameValue
LateDelivery1
IncorrectlyInstalled2
WrongEquipment3
ProjectOnHold4
CancellationReason5



LayerType

NameValue
ItemLayer1
ImageLayer2



LifeCycleStatusEnum

NameValue
ActiveDecommissioning1
ActiveMoving2
ActiveOperational3
ActiveRecycling4
PlannedDecommissioning5
PlannedMoving6
PlannedProcurement7
PlannedPreProcurement8
PlannedRecycling9
RecycledAvailable10
RecycledMoving11
Decommissioned13
CancelledCancelled14



LocationGroupTypeEnum

NameValue
World1
Region2
Country3
County4
City5
Building6
Floor7
Room8
Area9



LocationTarget

NameValue
AnyLocation0
SameRoom1
SameBuilding2
SameArea3



LocationType

NameValue
NotSet0
World1
Region2
Country3
County4
City5
Building6
Floor7
Room8
Area9



LocationUsageFlags

NameValue
None0
Move1
Recycle2
Decommission4
All7



LoggerEvents

NameValue
Elapsed0
ElapsedBefore5
ElapsedBeforeBaseControllerBegins10
SpentOnController12
SpentOnControllerWithoutOData15
SpentOnDbExtendedCommandInterception16
SpentOnDbCommandTreeInterception18
SpentOnDbCommandTreeSortInterception20
SpentOnDbCommandTreeSkipInterception21
SpentOnDbCommandTreeFunctionInterception30
SpentOnDbCommandTreeScanInterception40
SpentOnLocationGroupOrChildrenCommandInterceptor43
SpentOnGroupsOfResourceCommandInterceptor44
SpentOnJoinCommandInterceptor45
SpentOnContainsSearchCommandInterceptor47
SpentOnLicenseChecking50
SpentOnAuthorizationChecking60
SpentOnModelValidation70
SpentOnODataQueryPreparation80
SpentOnODataPostProcessing90
SpentCommittingOrRollingBackEfQuery100
ElapsedBeforeFinalSerialization110



MaterialImageTypeEnum

NameValue
Front1
Rear2



MaterialRecordStatus

NameValue
Planned1
Active2
Inactive3
Cancelled4



MaterialTypeEnum

NameValue
Server1
PDU2
Powerstrip3
Cabinet4
Network5
Peripheral6
KVMSwitch7
AirConditioning8
Receptacle9
Chassis53
Auxiliary54
StaticSwitch56
UPS57
Host99



MeasurementSystem

NameValue
Metric1
Imperial2



Module

NameValue
Workflow1
Reporting2
API3
Realtime4
Discover5
DiscoverInventory6
Predict7
Dashboards8
ConnectionVisualization9
BulkAutoAllocation10
AssetSyncFramework11
Mobile12
Hygiene14
DataCenter15
NEO101
NSUM102
Command104
ML201
AssetExplorer301



MountingPlacement

NameValue
Unmounted0
Internal1
OutsideRails2
OutsideRailsLeft3
OutsideRailsRight4



MountingRotation

NameValue
Front1
Back2
Right3
Left4
OnRight5
OnLeft6



MountingSide

NameValue
Unmounted0
Front1
Back2



MountingTypeEnum

NameValue
Rack19inch1
FullwidthShelf2
FloorStanding3



NetworkLinkerType

NameValue
None0
NetworkCard1
Patch2
Cable3



NetworkPanelTypeEnum

NameValue
FacePlate1
FloorBox2



NetworkPortGroupTypeEnum

NameValue
MPO0081
MPO0122
MPO0163
MPO0244
MPO0325
MPO0366
MPO0487
MPO0728
MPO1449
QSFPCopper10
QSFPFiber11



NetworkPortType

NameValue
Copper1
Fibre2
Unknown3



NetworkPortTypeEnum

NameValue
Copper1
Fiber2
Undefined3



NetworkSubTypeEnum

NameValue
Standard7
Module8
PatchPanel9



NetworkType

NameValue
Standard7
Module8
Panel9
NetworkCard10



NoteEntityType

NameValue
None0
Asset1
BusinessGroup2
InternalEquipmentItem3
InternalEquipmentItemUtilization4
SupportGroup5
IPAddressNetworkDependency6
AssetAssociationMap7
Host8
NetworkPort9
PeripheralAssetLink10
ServiceRequest11
TaskInstance12
LocationGroup13



OperationalStatusEnum

NameValue
PreProcurement1
Procurement2
Operational3
Recycling4
Decommissioning5
Available6
Moving7
Decommissioned8
Cancelled9



OrganisationGroupRecordStatus

NameValue
Active1
Cancelled2



PermissionState

NameValue
NotSet0
Allow4
Deny-1



PinConfigurationEnum

NameValue
_2PplusE1
_3PplusE2
_3PplusNplusE3



PointTypeEnum

NameValue
Temperature1
Humidity2
LeakDetect3



PolicyMandatorySetting

NameValue
Off1
Error2



PolicyResult

NameValue
Ok0
MandatoryValueRequired1
UniqueValueWarning2
UniqueValueRequired3



PolicyUniqueSetting

NameValue
Off1
Warning2
Error3



PollTypeEnum

NameValue
Modbus1
SNMP2
JSON3
XML4
JCI5
ALC6
Tridium7
Modius8
OPC9
CSV10
BACnetIP11
ModbusRTU12
PacketPower13



PortLocation

NameValue
None0
Patch1
Cable2
HybridPatch3
HybridNetworkCard4



PortState

NameValue
Free1
Patched2
Connected3
Broken4
Reserved5
PatchedReserved6
Planned7
Mixed-1



PositionOnGrid

NameValue
Row1
Column2



PowerBatteryTypeEnum

NameValue
VRLA1
Wet2
NiCd3
Li4



PowerConnectionRequestType

NameValue
Connect0
Disconnect1
DisconnectAll2
ModifyCapacity3
ModifyPowerState4
UpdateDetails5



PowerStateEnum

NameValue
Off0
On1



PowerTypeEnum

NameValue
None0
OnePhase1
TwoPhase2
ThreePhase3
DirectCurrent10



PredefinedListType

NameValue
CabinetUsage1
Project2
ProjectAction3
FunctionalUse5
OperationalUse6
ServerHostCompliance7
BusinessApplicationLifecycleStatus8
BusinessApplicationStrategy9
BusinessCriticality10
DataConfidentiality11
DataRecovery12
StorageUsage13
SoftwareType14
NetworkConnector20
NetworkCableType21
NetworkSpeed22
NetworkCardPortName23
IPUsage24
NetworkUsage25
NetworkPortDataType26
PhysicalPartitionType30
LogicalPartitionType40



Priority

NameValue
Urgent1
High2
Medium3
Low4



PriorityFocus

NameValue
Urgent1
PastDuration2
Viewed3
None4



ProcessCategory

NameValue
WindowsServer1
UnixServer2
IbmServer3



ProcessStatus

NameValue
New1
Draft2
OnHold3
Archived4
Validated5
Published6



ProcessType

NameValue
New1
Upgrade2
Move3
Decommission4
Recycle5



ProjectItemActionEnum

NameValue
Allocate1
CreateAndAllocate2
DuplicateAndAllocate3
Decommission4



ProjectItemStatusEnum

NameValue
Planned1
Completed3
Cancelled4
NonViable8
Broken9
Allocated10
Deleted11
Forecasted12



ProjectJobAction

NameValue
AutoAllocate1
Forecast2
Commit3
Cancel4
Complete5
None-1



ProjectStatusEnum

NameValue
Planned1
Committed2
Completed3
CompletedCancelled4
InProgress5
Forecast6
Viable7
NonViable8
Broken9
Allocated10
Forecasted12



ProjectTypeEnum

NameValue
AutoAllocation1
Forecast2
All3



Reason

NameValue
TaskOpened1
TaskClosed2
TaskAssigned3
TaskOpenReminder4
ServiceMaxLoopExceeded5
ServiceRequestFaulted6
ServiceRequestCancelled7
ServiceRequestCompleted8
ServiceRequestStarted9
TaskInstanceReassigned10
TaskSkipped11
TaskCancelled12



RecordStatusEnum

NameValue
Planned1
Active2
Recycled3
Decommissioned4
Cancelled5



RelocateType

NameValue
Move1
Recycle2
Decommission4
AutoAllocateDuplicate7



RoomItemCategory

NameValue
CableTray1
PopulatedCableTray2
NarrowCableBasket3
PopulatedNarrowCableBasket4
WideCableBasket5
PopulatedWideCableBasket6
VentedTile20
TilewithCentralRectangularHole21
TilewithCentralRectangularHoleonOneSide22
TilewithCentralRoundHole23
TilewithCentralSquareHole24
TilewithCentralSquareHoleonOneSide25
FireSensor40
FireSuppressionSystem41
HeatSensor42
SmokeSensor43
WaterSensor44
DoubleLeafDoor60
DoubleLeafDoorWithHalfLeaf61
DoubleLeafSwingDoorWithHalfLeaf62
DoubleSwingDoor63
RevolvingDoor64
SingleLeafDoor65
SingleLeafSwingDoor66
SlidingDoor67
SlidingCentreDoor68
RoundColumn90
SquareColumn91
Window92



RoomOrientationEnum

NameValue
Unassigned0
BelowFloor1
Floor2
Bottom3
Middle4
Top5
Ceiling6



RuleOperandCustomType

NameValue
Assignee0
Performer1
Duration2
Status3
Location4



RuleOperandServiceRequestType

NameValue
Location0



RuleOperandTaskType

NameValue
Assignee0
Performer1
Duration2
Status3



RuleOperatorType

NameValue
EqualTo0
GreaterThan1
LessThan2
GreaterThanOrEqualTo3
LessThanOrEqualTo4
Contains5
NotEqualTo6
In7



SaveActionEnum

NameValue
NoAction0
Create1
Update2
Delete3



SaveOperationResult

NameValue
Ok0
ConcurrentlyModified1



ServiceRequestStatus

NameValue
SubmitRequested1
Draft2
Open3
Closed4
Hold6
Failed7
Cancelled8



SoftwareRecordStatus

NameValue
Planned1
Active2
Inactive3
Cancelled4



SupplierTypeEnum

NameValue
UtilityCompany1
Battery2



TaskContainerType

NameValue
BranchContainer101
Branch102
LoopContainer103
ParallelContainer104
SequenceContainer105



TaskInstanceActivityMode

NameValue
Inactive1
Finished2
Active3



TaskInstanceStatus

NameValue
Failed1
Skipped3
Open4
Active5
Pending7
Cancelled8
Completed9
Running10



TaskType

NameValue
UserTask1
CreateAsset2
MoveAsset3
RenameAsset4
RecycleAsset5
CompletePlannedAction7
Integration9
SLAStart10
EditAsset11
DecommissionAsset12



TopPanelEnum

NameValue
Closed1
Vented2
Assisted3



TraceFilterEnum

NameValue
ConnectedPorts1
Power2
PlannedPorts4



UnitsEnum

NameValue
Fahrenheit11
Celcius12
PercentageRH21
L_NL31



VoltsL2LEnum

NameValue
V4848
V190190
V200200
V208208
V220220
V230230
V240240
V280280
V380380
V400400
V415415
V440440
V480480
V600600



ZoneType

NameValue
Marker1
Walkway2