api [Supported API Request] assetSharedUsersAdd

[samwoo]

Good afternoon,

I would like to request for a supported API that will link one or more "Shared Users" to a given "Asset ID". 

Application: Service Manager
Entity: Assets
Name: assetSharedUsersAdd

Request Parameters:

• assetId <string/number> <required>
• userId <string array> <required>
• convertToShared <boolean default:FALSE> <optional> *

Response Parameters:

• userAddedCount <string/number>
• usersAdded <array>
  • User ID
  • Logon ID
  • Employee ID
  • Email Address
  • Type
  • Home Organization
• usersNotAdded <array>
  • User ID
  • Reason
• exceptionName <string>
• exceptionSummary <string>

Notes:

• The convertToShared request parameter would convert the Asset to a Shared Asset, if it's not currently one, before adding the Shared user(s)
• The usersAdded response parameter would return the details of the user from Hornbill once added. This might be overkill, and if so, this can be ignored.
• The usersNotAdded response parameter would return the details of the users not added, and the reason. For example, User ID doesn't exist in Hornbill, or the User ID is, but the account is Suspended or Archived. This might also be overkill, and if so, this can be ignored.

Thanks,

Samuel Wood

[samwoo]

Use case:

1. We run external PowerShell scripts that goes through the databases for multiple Applications on the estate.
2. We run automatically these to check if the users still exist in Active Directory, as well as doing other checks for example if there is no email address etc. The outputs of these checks are a HTML file that gets logged into Hornbill via the Email Routing rules and assigned to the relevant team for that Application.
3. If a User exists in Active Directory, and that they have been using these Applications, then the process also adds the User to the Asset in Hornbill. This is useful for our Movers and Leaver processes.
4. Currently, there are no supported API's related to Shared Users against Assets, we are currently using the old API's for these processes.