Table of Contents

UAM API Changes

Warning

Some API changes are not backward compatible

Breaking Changes

Path Description
GET /Modules/UAM/Users/{id}/Options Changed WorkOrderLimit property data type from integer to number
GET /Modules/UAM/Users/Options/{id} Changed WorkOrderLimit property data type from integer to number
GET /Modules/UAM/Users/Options/Batch/{ids} Changed WorkOrderLimit property data type from integer to number

Changelog

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

==========================================================================
==                            API CHANGE LOG                            ==
==========================================================================
                      On Key UAM  API Specification                       
--------------------------------------------------------------------------
--                            What's Changed                            --
--------------------------------------------------------------------------
- POST   /Modules/UAM/Users/Batch/{ids}/CalculateUserPermissions
  Parameter:
    - Add from in query
- POST   /Modules/UAM/Users/{id}/CalculateUserPermissions
  Parameter:
    - Add schedule in query
    - Add from in query
- GET    /Modules/UAM/OperationalRoles/Resources/{id}
  Return Type:
    - Changed 200 OK
      Media types:
        - Changed application/vnd.onkey.entity+json
          Schema: Backward compatible
- GET    /Modules/UAM/OperationalRoles/Resources/Batch/{ids}
  Return Type:
    - Changed 200 OK
      Media types:
        - Changed application/vnd.onkey.entitycollection+json
          Schema: Backward compatible
- GET    /Modules/UAM/OperationalRoles/Templates/{id}
  Return Type:
    - Changed 200 OK
      Media types:
        - Changed application/vnd.onkey.entity+json
          Schema: Backward compatible
- GET    /Modules/UAM/OperationalRoles/Templates/Batch/{ids}
  Return Type:
    - Changed 200 OK
      Media types:
        - Changed application/vnd.onkey.entitycollection+json
          Schema: Backward compatible
- GET    /Modules/UAM/Users/OperationalRoles/Templates/{id}
  Return Type:
    - Changed 200 OK
      Media types:
        - Changed application/vnd.onkey.entity+json
          Schema: Backward compatible
- GET    /Modules/UAM/Users/OperationalRoles/Templates/Batch/{ids}
  Return Type:
    - Changed 200 OK
      Media types:
        - Changed application/vnd.onkey.entitycollection+json
          Schema: Backward compatible
- GET    /Modules/UAM/Users/{id}/Options
  Return Type:
    - Changed 200 OK
      Media types:
        - Changed application/vnd.onkey.entity+json
          Schema: Broken compatibility
          Changed property type: properties.workOrderLimit (integer -> number)
- GET    /Modules/UAM/Users/Options/{id}
  Return Type:
    - Changed 200 OK
      Media types:
        - Changed application/vnd.onkey.entity+json
          Schema: Broken compatibility
          Changed property type: properties.workOrderLimit (integer -> number)
- GET    /Modules/UAM/Users/Options/Batch/{ids}
  Return Type:
    - Changed 200 OK
      Media types:
        - Changed application/vnd.onkey.entitycollection+json
          Schema: Broken compatibility
          Changed property type: items[n].properties.workOrderLimit (integer -> number)
--------------------------------------------------------------------------
--                                Result                                --
--------------------------------------------------------------------------
                 API changes broke backward compatibility                 
--------------------------------------------------------------------------