API Changelog 3.6 to 3.7¶
What’s New¶
GET
/api/asset/dataCollectors/{assetId}¶
Returns an asset’s associated data collectors.
GET
/api/user/users/access/{accessPolicyId}¶
Returns an array of users associate with an access policy or associated to a group that is associated with an access policy. All users of Administrator role are included.
DELETE
/api/asset/workNoteDocuments/{workNoteDocumentId}¶
Removes an association between a work note and document.
GET
/api/asset/workNotes/asset/{assetId}¶
Returns a list of work notes for the given asset.
GET
/api/asset/workNotes/{workNoteId}¶
Returns an individual work note.
PUT
/api/asset/workNotes/{workNoteId}¶
Updates a work note and returns the updated work note.
DELETE
/api/asset/workNotes/{workNoteId}¶
Deletes a work note.
POST
/api/asset/workNotes¶
Creates a work note.
What’s Changed¶
DELETE
/api/asset/assetTrackerMasterModuleData/{id}¶
GET
/api/layout/backgroundImages/{id}¶
DELETE
/api/layout/backgroundImages/{id}¶
GET
/api/asset/controlDataCollector/{assetId}¶
POST
/api/setting/dataCollectorToken¶
DELETE
/api/setting/discoveryProtocolSettings/ports/{portId}¶
POST
/api/setting/discoveryProtocolSettings/protocolCredentials/{protocolCredentialId}¶
DELETE
/api/setting/discoveryProtocolSettings/protocolCredentials/{protocolCredentialId}¶
POST
/api/setting/discoveryRunner/{discoveryId}¶
POST
/api/setting/discoveryRunner/{discoveryId}/abort¶
GET
/api/setting/documentAccessPolicies/{documentId}¶
PUT
/api/setting/documentAccessPolicies/{documentId}¶
DELETE
/api/asset/documentAssociations/{assetDocumentAssociationId}¶
GET
/api/product/firmwareDownload/installFile/{firmwareVersionId}¶
GET
/api/product/firmwareDownload/releaseNote/{firmwareVersionId}¶
GET
/api/layout/floorPlanLayout/racksInRow/{rackId}¶
DELETE
/api/asset/indirectSensors/{sensorId}¶
PUT
/api/asset/manualSensors/numericSensor/{sensorId}/value¶
POST
/api/asset/monitorOnlyCommunicationSetting/{assetId}/refreshSensors¶
PUT
/api/asset/pduBreakers/breakerStatus/{pduBreakerId}¶
DELETE
/api/asset/powerSourceAssociations/{id}¶
GET
/api/layout/rackSearch¶
DELETE
/api/asset/savedSearches/user/{id}¶
DELETE
/api/asset/savedSearches/global/{id}¶
DELETE
/api/asset/sensors/{id}¶
PUT
/api/setting/serviceNowCmdbIntegration/resetLastSyncDate¶
PUT
/api/setting/serviceNowCmdbIntegration/initiateSync¶
DELETE
/api/product/userProductImages/{id}¶
POST
/api/asset/workOrderItemStatuses/manuallyComplete¶
DELETE
/api/asset/workOrders/completed¶
GET
/api/setting/accessPolicies¶
POST
/api/setting/accessPolicies¶
DELETE
/api/setting/accessPolicies/{accessPolicyId}¶
PUT
/api/setting/accessPolicies/{accessPolicyId}¶
GET
/api/asset/accessPolicies/{assetId}¶
PUT
/api/asset/accessPolicies/{assetId}¶
GET
/api/setting/accessPolicyGroups¶
GET
/api/setting/accessPolicyGroups/{accessPolicyId}¶
PUT
/api/asset/alarmEvents/acknowledgementState/{alarmEventId}¶
POST
/api/asset/assetFirmware¶
GET
/api/asset/availableFirmwareVersions/{assetId}¶
GET
/api/asset/availablePowerSources/outlets/{id}¶
GET
/api/asset/availablePowerSources/pduBreakers/{id}¶
GET
/api/asset/availablePowerSources/buswayTapOffs/{id}¶
GET
/api/asset/availableRackSpace/{id}¶
GET
/api/asset/availableRackSpace/{id}/sensors/{sensorId}¶
POST
/api/asset/bulk/assets/delete¶
POST
/api/asset/bulk/assets/addDocumentAssociation¶
POST
/api/asset/bulk/assets/removeDocumentAssociation¶
POST
/api/asset/bulk/assets/createEventNotificationRecipient¶
POST
/api/asset/bulk/assets/removeEventNotificationRecipient¶
POST
/api/asset/bulk/assets/disableMonitoring¶
POST
/api/asset/bulk/assets/enableMonitoring¶
POST
/api/asset/bulk/assets/updateControlCredentials¶
POST
/api/asset/bulk/assets/updateAccessPolicy¶
POST
/api/asset/bulk/assets/updateProduct¶
POST
/api/asset/buswayTapOff¶
DELETE
/api/asset/buswayTapOff/{buswayTapOffId}¶
PUT
/api/asset/buswayTapOff/{buswayTapOffId}¶
POST
/api/asset/controlCredentialAssociation¶
DELETE
/api/asset/controlCredentialAssociation¶
PUT
/api/asset/controlCredentialAssociation/{id}¶
PUT
/api/asset/controlOperations¶
GET
/api/asset/customComponents/assetPropertyValueStrings¶
GET
/api/setting/customPropertyGroup¶
POST
/api/setting/customPropertyGroup¶
DELETE
/api/setting/customPropertyGroup/{customPropertyGroupId}¶
PUT
/api/setting/customPropertyGroup/{customPropertyGroupId}¶
GET
/api/setting/dataCollector¶
POST
/api/setting/dataCollector/retire¶
POST
/api/asset/documentAssociations¶
GET
/api/asset/documentAssociations/assets/{documentId}¶
GET
/api/setting/documents/{documentId}¶
DELETE
/api/setting/documents/{documentId}¶
PUT
/api/setting/documents/{documentId}¶
POST
/api/setting/documents¶
GET
/api/asset/enumAssetProperties/{id}¶
GET
/api/setting/enumCustomAssetProperties/{customAssetPropertyKeyId}¶
POST
/api/asset/eventNotificationRecipient/{assetId}¶
DELETE
/api/asset/eventNotificationRecipient/{assetId}¶
GET
/api/asset/eventNotificationRecipient/{assetId}¶
GET
/api/product/firmwareVersions/{firmwareVersionId}¶
GET
/api/product/firmwareVersions/firmware/{firmwareId}¶
GET
/api/product/image¶
POST
/api/asset/manualSensors¶
GET
/api/product/manufacturers¶
POST
/api/product/manufacturers¶
DELETE
/api/product/manufacturers/{id}¶
GET
/api/product/manufacturers/{id}¶
PUT
/api/product/manufacturers/{id}¶
POST
/api/asset/merge¶
PUT
/api/asset/pduBreakers/{pduBreakerId}¶
GET
/api/product/productProperties/{productId}¶
POST
/api/product/productProperties/{productId}¶
DELETE
/api/product/productProperties/{id}¶
PUT
/api/product/productProperties/{id}¶
GET
/api/product/productTypes¶
GET
/api/asset/search/aggregations¶
GET
/api/asset/software/{id}¶
GET
/api/user/users¶
GET
/api/user/users/accessPolicyUsers/{accessPolicyId}¶
Return Type:¶
Changed response : 200 OK
Success
Changed content type :
application/json
Changed items (object):
Added property
firstName
(string)Added property
lastName
(string)Added property
email
(string)
GET
/api/asset/widget/assetPropertyListWidget/{assetId}¶
GET
/api/asset/widget/assetLifecycleWidget/{assetId}¶
GET
/api/asset/widget/assetsByTypeWidget/{locationId}¶
GET
/api/asset/widget/assetSummaryWidget/{assetId}¶
POST
/api/asset/alarmEvents¶
GET
/api/asset/alarmEvents¶
GET
/api/asset/ancestors/{assetId}¶
DELETE
/api/asset/assetProperties/{id}¶
GET
/api/asset/assetProperties/{id}¶
PUT
/api/asset/assetProperties/{id}¶
POST
/api/asset/assetProperties¶
GET
/api/asset/assetTrackerAlarmEvents¶
GET
/api/asset/assetTrackerMasterModuleData¶
GET
/api/asset/assetTree/{assetId}¶
GET
/api/asset/assetTypeCount¶
GET
/api/setting/assetTypeDashboardSettings/{assetTypeId}¶
PUT
/api/setting/assetTypeDashboardSettings¶
GET
/api/asset/assetsByType¶
POST
/api/layout/backgroundImages¶
GET
/api/layout/backgroundImages¶
GET
/api/setting/bacnetIpDefinitions¶
POST
/api/setting/bacnetIpDefinitions¶
DELETE
/api/setting/bacnetIpDefinitions/{bacnetIpDefinitionId}¶
GET
/api/setting/bacnetIpDefinitions/{bacnetIpDefinitionId}¶
PUT
/api/setting/bacnetIpDefinitions/{bacnetIpDefinitionId}¶
GET
/api/setting/bacnetIpDefinitions/bacnetIpNonNumericSensors/{bacnetIpDefinitionId}¶
POST
/api/setting/bacnetIpDefinitions/bacnetIpNonNumericSensors/{bacnetIpDefinitionId}¶
DELETE
/api/setting/bacnetIpDefinitions/bacnetIpNonNumericSensors/{bacnetIpDefinitionId}/{bacnetIpNonNumericSensorId}¶
PUT
/api/setting/bacnetIpDefinitions/bacnetIpNonNumericSensors/{bacnetIpDefinitionId}/{bacnetIpNonNumericSensorId}¶
GET
/api/setting/bacnetIpDefinitions/bacnetIpNumericSensors/{bacnetIpDefinitionId}¶
POST
/api/setting/bacnetIpDefinitions/bacnetIpNumericSensors/{bacnetIpDefinitionId}¶
DELETE
/api/setting/bacnetIpDefinitions/bacnetIpNumericSensors/{bacnetIpDefinitionId}/{bacnetIpNumericSensorId}¶
PUT
/api/setting/bacnetIpDefinitions/bacnetIpNumericSensors/{bacnetIpDefinitionId}/{bacnetIpNumericSensorId}¶
POST
/api/asset/bulk/assets/updateCustomProperty¶
POST
/api/asset/bulk/assets/updateLifecycle¶
GET
/api/asset/buswayTapOff/{assetId}¶
GET
/api/asset/containedAssets/general/{assetId}¶
POST
/api/asset/control/rackDoorElectronicLock¶
DELETE
/api/asset/customAssetProperties/{id}¶
GET
/api/asset/customAssetProperties/{id}¶
PUT
/api/asset/customAssetProperties/{id}¶
POST
/api/asset/customAssetProperties¶
GET
/api/asset/customComponents¶
POST
/api/asset/customComponents¶
DELETE
/api/asset/customComponents/{id}¶
PUT
/api/asset/customComponents/{id}¶
GET
/api/setting/customPropertySetting¶
POST
/api/setting/customPropertySetting¶
DELETE
/api/setting/customPropertySetting/{customPropertySettingId}¶
PUT
/api/setting/customPropertySetting/{customPropertySettingId}¶
GET
/api/setting/discoveries¶
POST
/api/setting/discoveries¶
GET
/api/setting/discoveries/{id}¶
DELETE
/api/setting/discoveries/{discoveryId}¶
PUT
/api/setting/discoveries/{discoveryId}¶
GET
/api/setting/discoveries/{discoveryId}/schedule¶
GET
/api/setting/discoveryAssetHistories/{discoveryHistoryId}¶
GET
/api/setting/discoveryHistories¶
GET
/api/setting/discoveryHistories/{discoveryHistoryId}¶
GET
/api/setting/discoveryProtocolSettings/ports¶
POST
/api/setting/discoveryProtocolSettings/ports¶
GET
/api/setting/discoveryProtocolSettings/protocols¶
PUT
/api/setting/discoveryProtocolSettings/protocols¶
GET
/api/setting/discoveryProtocolSettings/protocols/{protocolId}¶
GET
/api/setting/discoveryRanges¶
POST
/api/setting/discoveryRanges¶
DELETE
/api/setting/discoveryRanges/{id}¶
PUT
/api/setting/discoveryRanges/{id}¶
POST
/api/setting/discoverySchedules¶
DELETE
/api/setting/discoverySchedules/{discoveryScheduleId}¶
PUT
/api/setting/discoverySchedules/{discoveryScheduleId}¶
GET
/api/asset/documentAssociations/documentDetails/{assetId}¶
GET
/api/setting/documentDetails/{documentDetailsId}¶
GET
/api/setting/documentDetails¶
GET
/api/layout/floorPlanLayout/childrenState/{id}¶
GET
/api/layout/floorPlanLayoutGridInformation/{locationId}¶
GET
/api/asset/hierarchy¶
POST
/api/asset/indirectSensors¶
GET
/api/layout/layoutModeSetting/{locationId}¶
PUT
/api/layout/layoutModeSetting¶
POST
/api/layout/layoutModeSetting¶
GET
/api/setting/license¶
GET
/api/asset/lifecycleProperties/{assetId}¶
PUT
/api/asset/lifecycleProperties/{assetId}¶
PUT
/api/asset/location/{id}¶
GET
/api/layout/mapLocations/{locationId}¶
GET
/api/setting/modbusTcpDefinitions¶
POST
/api/setting/modbusTcpDefinitions¶
DELETE
/api/setting/modbusTcpDefinitions/{modbusTcpDefinitionId}¶
GET
/api/setting/modbusTcpDefinitions/{modbusTcpDefinitionId}¶
PUT
/api/setting/modbusTcpDefinitions/{modbusTcpDefinitionId}¶
GET
/api/setting/modbusTcpDefinitions/modbusTcpNonNumericSensors/{modbusTcpDefinitionId}¶
POST
/api/setting/modbusTcpDefinitions/modbusTcpNonNumericSensors/{modbusTcpDefinitionId}¶
DELETE
/api/setting/modbusTcpDefinitions/modbusTcpNonNumericSensors/{modbusTcpDefinitionId}/{modbusTcpNonNumericSensorId}¶
PUT
/api/setting/modbusTcpDefinitions/modbusTcpNonNumericSensors/{modbusTcpDefinitionId}/{modbusTcpNonNumericSensorId}¶
GET
/api/setting/modbusTcpDefinitions/modbusTcpNumericSensors/{modbusTcpDefinitionId}¶
POST
/api/setting/modbusTcpDefinitions/modbusTcpNumericSensors/{modbusTcpDefinitionId}¶
DELETE
/api/setting/modbusTcpDefinitions/modbusTcpNumericSensors/{modbusTcpDefinitionId}/{modbusTcpNumericSensorId}¶
PUT
/api/setting/modbusTcpDefinitions/modbusTcpNumericSensors/{modbusTcpDefinitionId}/{modbusTcpNumericSensorId}¶
GET
/api/asset/outlets¶
POST
/api/asset/pduBreakers¶
GET
/api/asset/pduBreakers¶
GET
/api/asset/powerPath/{assetId}/children¶
POST
/api/asset/powerSourceAssociations¶
GET
/api/asset/powerSourceAssociations¶
GET
/api/product/productPropertyKeys/{productTypeId}¶
GET
/api/product/products¶
POST
/api/product/products¶
DELETE
/api/product/products/{id}¶
PUT
/api/product/products/{id}¶
GET
/api/product/products/{id}¶
GET
/api/asset/rackSecurity/{assetId}¶
GET
/api/asset/rackSecurity/{locationId}/racks¶
GET
/api/asset/savedSearches¶
POST
/api/asset/savedSearches¶
GET
/api/asset/savedSearches/global¶
GET
/api/setting/sensorThreshold¶
POST
/api/setting/sensorThreshold¶
DELETE
/api/setting/sensorThreshold/{sensorThresholdId}¶
PUT
/api/setting/sensorThreshold/{sensorThresholdId}¶
GET
/api/setting/sensorTypeAssetType¶
GET
/api/asset/sensors/{assetId}¶
GET
/api/asset/sensorsDailySummaries/numeric¶
GET
/api/asset/sensorsDailySummaries/numeric/{timeRange}¶
GET
/api/asset/sensorsDailySummaries/string¶
GET
/api/asset/sensorsDailySummaries/string/{timeRange}¶
GET
/api/asset/sensorsDataPoints/numeric¶
GET
/api/asset/sensorsDataPoints/numeric/{timeRange}¶
GET
/api/asset/sensorsDataPoints/string¶
GET
/api/asset/sensorsDataPoints/string/{timeRange}¶
GET
/api/setting/serviceNowCmdbConfiguration¶
PUT
/api/setting/serviceNowCmdbConfiguration¶
GET
/api/setting/systemSettings¶
Parameters:¶
Changed: systemSettings
in query
A list of system setting IDs.
Return Type:¶
Changed response : 200 OK
Success
Changed content type :
application/json
Changed items (object):
Changed property
id
(string)Added enum values:
serviceNowCmdbIntegrationHttpRetryCount
serviceNowCmdbIntegrationAssetBatchSize
serviceNowCmdbIntegrationRetrySleepIntervalInSeconds
PUT
/api/setting/systemSettings¶
Request:¶
Changed content type : application/json
Changed items (object):
Changed property
id
(string)Added enum values:
serviceNowCmdbIntegrationHttpRetryCount
serviceNowCmdbIntegrationAssetBatchSize
serviceNowCmdbIntegrationRetrySleepIntervalInSeconds
Return Type:¶
Changed response : 200 OK
Success
Changed content type :
application/json
Changed items (object):
Changed property
id
(string)Added enum values:
serviceNowCmdbIntegrationHttpRetryCount
serviceNowCmdbIntegrationAssetBatchSize
serviceNowCmdbIntegrationRetrySleepIntervalInSeconds
GET
/api/setting/systemSettings/{systemSettingId}¶
Parameters:¶
Changed: systemSettingId
in path
ID of system setting.
Return Type:¶
Changed response : 200 OK
Success
Changed content type :
application/json
Changed property
id
(string)Added enum values:
serviceNowCmdbIntegrationHttpRetryCount
serviceNowCmdbIntegrationAssetBatchSize
serviceNowCmdbIntegrationRetrySleepIntervalInSeconds
GET
/api/setting/systemSettings/dataCollector/{dataCollectorSetting}¶
PUT
/api/setting/systemSettings/dataCollector¶
POST
/api/product/userProductImages/{productId}¶
GET
/api/product/userProductImages/{productId}¶
GET
/api/asset/watchedAssets¶
DELETE
/api/asset/workOrders/{workOrderId}¶
GET
/api/asset/workOrders/{workOrderId}¶
GET
/api/setting/applicationEventLogs¶
Return Type:¶
Changed response : 200 OK
Success
Changed content type :
application/json
Changed items (object):
Changed property
eventType
(string)Added enum values:
workNoteDeleted
workNoteAdded
workNoteUpdated
workNoteDocumentDeleted
workNoteDocumentAdded
workNoteImportanceUpdated
GET
/api/asset/assetChangeEventLogs¶
Return Type:¶
Changed response : 200 OK
Success
Changed content type :
application/json
Changed items (object):
Changed property
eventType
(string)Added enum values:
workNoteDeleted
workNoteAdded
workNoteUpdated
workNoteDocumentDeleted
workNoteDocumentAdded
workNoteImportanceUpdated
GET
/api/asset/assetTrackerContainedAssets¶
DELETE
/api/asset/assets/{id}¶
GET
/api/asset/assets/{id}¶
PUT
/api/asset/assets/{id}¶
GET
/api/asset/componentAssets/{assetId}¶
GET
/api/asset/componentAssets/{assetId}/virtualComponents¶
GET
/api/asset/componentAssets/{assetId}/networkComponents¶
GET
/api/asset/containedAssets/elevation/{parentId}¶
GET
/api/asset/controlCredentialAssociation/{assetId}¶
GET
/api/setting/credentials¶
POST
/api/setting/credentials¶
DELETE
/api/setting/credentials/{credentialId}¶
GET
/api/setting/credentials/{credentialId}¶
PUT
/api/setting/credentials/{credentialId}¶
GET
/api/asset/discoveryReport/{assetId}¶
GET
/api/layout/floorPlanLayout/{id}¶
PUT
/api/layout/floorPlanLayout¶
GET
/api/asset/monitorOnlyCommunicationSetting/{assetId}¶
PUT
/api/asset/monitorOnlyCommunicationSetting/{assetId}¶
GET
/api/asset/powerPath/{assetId}/ancestry¶
PUT
/api/asset/rackShelf/{id}¶
POST
/api/asset/search¶
Return Type:¶
Changed response : 200 OK
Success
Changed content type :
application/json
Changed items (object):
Added property
designValue
(array)Items (number):