Table of Contents

AMPC.ASSETS API Changes

Warning

Some API changes are not backward compatible

A more detailed breakdown for the individual changes can be viewed here

==========================================================================
==                            API CHANGE LOG                            ==
==========================================================================
                   On Key AMPC Assets API Specification                   
--------------------------------------------------------------------------
--                              What's New                              --
--------------------------------------------------------------------------
- PATCH  /Modules/AMPC/RegularAssets/{id}/ChangeType/{assetType}
- PATCH  /Modules/AMPC/RegularAssets/Batch/ChangeType
- GET    /Modules/AMPC/RegularAssets/OptionValues/Lookups/LookupRegularAssetOptionValueOption

--------------------------------------------------------------------------
--                            What's Deleted                            --
--------------------------------------------------------------------------
- GET    /Modules/AMPC/RegularAssets/OptionValues/Lookups/LookupRegularAssetOptionValueRegularAssetTypeOption

--------------------------------------------------------------------------
--                            What's Changed                            --
--------------------------------------------------------------------------
- GET    /Modules/AMPC/Assets/Tree/{parentNodeType}/{parentIds}/WorkOrders/Recursive
  Return Type:
    - Changed 200 OK
      Media types:
        - Changed application/vnd.onkey.entitycollectionpage+json
          Schema: Broken compatibility
          Missing property: items[n].properties.phone (string)
- GET    /Modules/AMPC/Assets/Tree
  Parameter:
    - Changed showInActive in query
    - Changed showDeletedConfirmed in query
    - Changed showRuleEvaluationFailed in query
- GET    /Modules/AMPC/Assets/Tree/{parentNodeType}/{parentId}/AuxiliaryAssetTasks
  Parameter:
    - Changed showInActive in query
    - Changed showDeletedConfirmed in query
    - Changed showRuleEvaluationFailed in query
- GET    /Modules/AMPC/Assets/Tree/{parentNodeType}/{parentId}/InPlaceAssets
  Parameter:
    - Changed showInActive in query
    - Changed showDeletedConfirmed in query
    - Changed showRuleEvaluationFailed in query
- GET    /Modules/AMPC/Assets/Tree/{parentNodeType}/{parentId}/PlaceholderAssets
  Parameter:
    - Changed showInActive in query
    - Changed showDeletedConfirmed in query
    - Changed showRuleEvaluationFailed in query
- GET    /Modules/AMPC/Assets/Tree/{parentNodeType}/{parentId}/PlaceholderAssetComponents
  Parameter:
    - Changed showInActive in query
    - Changed showDeletedConfirmed in query
    - Changed showRuleEvaluationFailed in query
- GET    /Modules/AMPC/Assets/Tree/{parentNodeType}/{parentId}/RegularAssets
  Parameter:
    - Changed showInActive in query
    - Changed showDeletedConfirmed in query
    - Changed showRuleEvaluationFailed in query
- GET    /Modules/AMPC/Assets/Tree/{parentNodeType}/{parentId}/RegularAssetComponents
  Parameter:
    - Changed showInActive in query
    - Changed showDeletedConfirmed in query
    - Changed showRuleEvaluationFailed in query
- GET    /Modules/AMPC/Assets/Tree/{parentNodeType}/{parentId}/RegularAssetTaskAuxiliaryTasks
  Parameter:
    - Changed showInActive in query
    - Changed showDeletedConfirmed in query
    - Changed showRuleEvaluationFailed in query
- GET    /Modules/AMPC/Assets/Tree/{parentNodeType}/{parentId}/RegularAssetTasks
  Parameter:
    - Changed showInActive in query
    - Changed showDeletedConfirmed in query
    - Changed showRuleEvaluationFailed in query
- GET    /Modules/AMPC/Assets/Tree/{parentNodeType}/{parentId}/RegularAssetTaskFollowUpTasks
  Parameter:
    - Changed showInActive in query
    - Changed showDeletedConfirmed in query
    - Changed showRuleEvaluationFailed in query
- GET    /Modules/AMPC/Assets/Tree/{parentNodeType}/{parentId}/RegularAssetTaskSuppressedTasks
  Parameter:
    - Changed showInActive in query
    - Changed showDeletedConfirmed in query
    - Changed showRuleEvaluationFailed in query
- POST   /Modules/AMPC/AuxiliaryAssetTasks/{id}/DevelopmentStatus/Accept
  Parameter:
    - Changed includeChildren in query
- POST   /Modules/AMPC/AuxiliaryAssetTasks/Batch/{ids}/DevelopmentStatus/Accept
  Parameter:
    - Changed includeChildren in query
- POST   /Modules/AMPC/AuxiliaryAssetTasks/Batch/{ids}/DevelopmentStatus/Reject
  Parameter:
    - Changed includeChildren in query
- PATCH  /Modules/AMPC/AuxiliaryAssetTasks/{id}/Active
  Parameter:
    - Add includeDetails in query
    - Changed includeChildren in query
- PATCH  /Modules/AMPC/AuxiliaryAssetTasks/{id}/PermissionTree
  Parameter:
    - Changed includeChildren in query
- POST   /Modules/AMPC/AuxiliaryAssetTasks/{id}/DevelopmentStatus/Reject
  Parameter:
    - Changed includeChildren in query
- PATCH  /Modules/AMPC/AuxiliaryAssetTasks/Batch/Active
  Parameter:
    - Add includeDetails in query
    - Changed includeChildren in query
- PATCH  /Modules/AMPC/AuxiliaryAssetTasks/Batch/PermissionTree
  Parameter:
    - Changed includeChildren in query
- POST   /Modules/AMPC/InPlaceAssets/{id}/DevelopmentStatus/Accept
  Parameter:
    - Changed includeChildren in query
- POST   /Modules/AMPC/InPlaceAssets/Batch/{ids}/DevelopmentStatus/Accept
  Parameter:
    - Changed includeChildren in query
- POST   /Modules/AMPC/InPlaceAssets/Batch/{ids}/DevelopmentStatus/Reject
  Parameter:
    - Changed includeChildren in query
- PATCH  /Modules/AMPC/InPlaceAssets/{id}/Active
  Parameter:
    - Add includeDetails in query
    - Changed includeChildren in query
- PATCH  /Modules/AMPC/InPlaceAssets/{id}/PermissionTree
  Parameter:
    - Changed includeChildren in query
- POST   /Modules/AMPC/InPlaceAssets/{id}/DevelopmentStatus/Reject
  Parameter:
    - Changed includeChildren in query
- PATCH  /Modules/AMPC/InPlaceAssets/Batch/Active
  Parameter:
    - Add includeDetails in query
    - Changed includeChildren in query
- PATCH  /Modules/AMPC/InPlaceAssets/Batch/PermissionTree
  Parameter:
    - Changed includeChildren in query
- POST   /Modules/AMPC/PlaceholderAssets/{id}/DevelopmentStatus/Accept
  Parameter:
    - Changed includeChildren in query
- POST   /Modules/AMPC/PlaceholderAssets/Batch/{ids}/DevelopmentStatus/Accept
  Parameter:
    - Changed includeChildren in query
- POST   /Modules/AMPC/PlaceholderAssets/Batch/{ids}/DevelopmentStatus/Reject
  Parameter:
    - Changed includeChildren in query
- POST   /Modules/AMPC/PlaceholderAssets/Batch/{ids}/Sync
  Parameter:
    - Changed includeChildren in query
- PATCH  /Modules/AMPC/PlaceholderAssets/{id}/Active
  Parameter:
    - Add includeDetails in query
    - Changed includeChildren in query
- PATCH  /Modules/AMPC/PlaceholderAssets/{id}/PermissionTree
  Parameter:
    - Changed includeChildren in query
- POST   /Modules/AMPC/PlaceholderAssets/{id}/DevelopmentStatus/Reject
  Parameter:
    - Changed includeChildren in query
- POST   /Modules/AMPC/PlaceholderAssets/{id}/Sync
  Parameter:
    - Changed includeChildren in query
- PATCH  /Modules/AMPC/PlaceholderAssets/Batch/Active
  Parameter:
    - Add includeDetails in query
    - Changed includeChildren in query
- PATCH  /Modules/AMPC/PlaceholderAssets/Batch/PermissionTree
  Parameter:
    - Changed includeChildren in query
- POST   /Modules/AMPC/PlaceholderAssetComponents/{id}/DevelopmentStatus/Accept
  Parameter:
    - Changed includeChildren in query
- POST   /Modules/AMPC/PlaceholderAssetComponents/Batch/{ids}/DevelopmentStatus/Accept
  Parameter:
    - Changed includeChildren in query
- POST   /Modules/AMPC/PlaceholderAssetComponents/Batch/{ids}/DevelopmentStatus/Reject
  Parameter:
    - Changed includeChildren in query
- POST   /Modules/AMPC/PlaceholderAssetComponents/Batch/{ids}/Sync
  Parameter:
    - Changed includeChildren in query
- PATCH  /Modules/AMPC/PlaceholderAssetComponents/{id}/Active
  Parameter:
    - Add includeDetails in query
    - Changed includeChildren in query
- PATCH  /Modules/AMPC/PlaceholderAssetComponents/{id}/PermissionTree
  Parameter:
    - Changed includeChildren in query
- POST   /Modules/AMPC/PlaceholderAssetComponents/{id}/DevelopmentStatus/Reject
  Parameter:
    - Changed includeChildren in query
- POST   /Modules/AMPC/PlaceholderAssetComponents/{id}/Sync
  Parameter:
    - Changed includeChildren in query
- PATCH  /Modules/AMPC/PlaceholderAssetComponents/Batch/Active
  Parameter:
    - Add includeDetails in query
    - Changed includeChildren in query
- PATCH  /Modules/AMPC/PlaceholderAssetComponents/Batch/PermissionTree
  Parameter:
    - Changed includeChildren in query
- POST   /Modules/AMPC/RegularAssets/{id}/DevelopmentStatus/Accept
  Parameter:
    - Changed includeChildren in query
- POST   /Modules/AMPC/RegularAssets/Batch/{ids}/DevelopmentStatus/Accept
  Parameter:
    - Changed includeChildren in query
- POST   /Modules/AMPC/RegularAssets/Batch/{ids}/DevelopmentStatus/Reject
  Parameter:
    - Changed includeChildren in query
- POST   /Modules/AMPC/RegularAssets/Batch/{ids}/Sync
  Parameter:
    - Changed includeChildren in query
- PATCH  /Modules/AMPC/RegularAssets/{id}/Active
  Parameter:
    - Add includeDetails in query
    - Changed includeChildren in query
- PATCH  /Modules/AMPC/RegularAssets/{id}/PermissionTree
  Parameter:
    - Changed includeChildren in query
- POST   /Modules/AMPC/RegularAssets/{id}/DevelopmentStatus/Reject
  Parameter:
    - Changed includeChildren in query
- POST   /Modules/AMPC/RegularAssets/{id}/Sync
  Parameter:
    - Changed includeChildren in query
- PATCH  /Modules/AMPC/RegularAssets/Batch/Active
  Parameter:
    - Add includeDetails in query
    - Changed includeChildren in query
- PATCH  /Modules/AMPC/RegularAssets/Batch/PermissionTree
  Parameter:
    - Changed includeChildren in query
- POST   /Modules/AMPC/RegularAssetComponents/{id}/DevelopmentStatus/Accept
  Parameter:
    - Changed includeChildren in query
- POST   /Modules/AMPC/RegularAssetComponents/Batch/{ids}/DevelopmentStatus/Accept
  Parameter:
    - Changed includeChildren in query
- POST   /Modules/AMPC/RegularAssetComponents/Batch/{ids}/DevelopmentStatus/Reject
  Parameter:
    - Changed includeChildren in query
- POST   /Modules/AMPC/RegularAssetComponents/Batch/{ids}/Sync
  Parameter:
    - Changed includeChildren in query
- PATCH  /Modules/AMPC/RegularAssetComponents/{id}/Active
  Parameter:
    - Add includeDetails in query
    - Changed includeChildren in query
- PATCH  /Modules/AMPC/RegularAssetComponents/{id}/PermissionTree
  Parameter:
    - Changed includeChildren in query
- POST   /Modules/AMPC/RegularAssetComponents/{id}/DevelopmentStatus/Reject
  Parameter:
    - Changed includeChildren in query
- POST   /Modules/AMPC/RegularAssetComponents/{id}/Sync
  Parameter:
    - Changed includeChildren in query
- PATCH  /Modules/AMPC/RegularAssetComponents/Batch/Active
  Parameter:
    - Add includeDetails in query
    - Changed includeChildren in query
- PATCH  /Modules/AMPC/RegularAssetComponents/Batch/PermissionTree
  Parameter:
    - Changed includeChildren in query
- PATCH  /Modules/AMPC/RegularAssets/Conditions/{id}
  Parameter:
    - Changed applyToTaskConditions in query
- POST   /Modules/AMPC/RegularAssets/Conditions
  Parameter:
    - Changed applyToTaskConditions in query
  Request:
        - Changed application/vnd.onkey.entity+json
          Schema: Backward compatible
- POST   /Modules/AMPC/RegularAssets/Conditions/Batch
  Parameter:
    - Changed applyToTaskConditions in query
  Request:
        - Changed application/vnd.onkey.entitycollection+json
          Schema: Backward compatible
- PATCH  /Modules/AMPC/RegularAssets/Conditions/Batch
  Parameter:
    - Changed applyToTaskConditions in query
- GET    /Modules/AMPC/RegularAssets/{id}/MonitoringPointTriggers
  Return Type:
    - Changed 200 OK
      Media types:
        - Changed application/vnd.onkey.entitycollectionpage+json
          Schema: Backward compatible
- GET    /Modules/AMPC/RegularAssetTasks/{regularAssetTaskId}/DueTasks
  Return Type:
    - Changed 200 OK
      Media types:
        - Changed application/vnd.onkey.entitycollectionpage+json
          Schema: Backward compatible
- POST   /Modules/AMPC/RegularAssetTasks/{id}/DevelopmentStatus/Accept
  Parameter:
    - Changed includeChildren in query
- POST   /Modules/AMPC/RegularAssetTasks/Batch/{ids}/DevelopmentStatus/Accept
  Parameter:
    - Changed includeChildren in query
- POST   /Modules/AMPC/RegularAssetTasks/Batch/{ids}/DevelopmentStatus/Reject
  Parameter:
    - Changed includeChildren in query
- POST   /Modules/AMPC/RegularAssetTasks/Batch/{ids}/Sync
  Parameter:
    - Changed includeChildren in query
- PATCH  /Modules/AMPC/RegularAssetTasks/{id}/Active
  Parameter:
    - Add includeDetails in query
    - Changed includeChildren in query
- PATCH  /Modules/AMPC/RegularAssetTasks/{id}/PermissionTree
  Parameter:
    - Changed includeChildren in query
- POST   /Modules/AMPC/RegularAssetTasks/{id}/DevelopmentStatus/Reject
  Parameter:
    - Changed includeChildren in query
- POST   /Modules/AMPC/RegularAssetTasks/{id}/Sync
  Parameter:
    - Changed includeChildren in query
- PATCH  /Modules/AMPC/RegularAssetTasks/Batch/Active
  Parameter:
    - Add includeDetails in query
    - Changed includeChildren in query
- PATCH  /Modules/AMPC/RegularAssetTasks/Batch/PermissionTree
  Parameter:
    - Changed includeChildren in query
- PATCH  /Modules/AMPC/RegularAssetTasks/FollowUpTasks/{id}/Active
  Parameter:
    - Add includeDetails in query
    - Changed includeChildren in query
- PATCH  /Modules/AMPC/RegularAssetTasks/FollowUpTasks/{id}/PermissionTree
  Parameter:
    - Changed includeChildren in query
- PATCH  /Modules/AMPC/RegularAssetTasks/FollowUpTasks/Batch/Active
  Parameter:
    - Add includeDetails in query
    - Changed includeChildren in query
- PATCH  /Modules/AMPC/RegularAssetTasks/FollowUpTasks/Batch/PermissionTree
  Parameter:
    - Changed includeChildren in query
--------------------------------------------------------------------------
--                                Result                                --
--------------------------------------------------------------------------
                 API changes broke backward compatibility                 
--------------------------------------------------------------------------