Documentation

This is taking longer than usual. If nothing appears, refresh the page.

Documentation

Enter at least two characters to search
    {{docApp.userSession.userId}}
    {{docApp.userSession.userName}}
    {{docApp.userSession.email}}
    Issuer : {{docApp.userSession.issuerInstance}}
    Expires : {{new Date(docApp.userSession.validUntil).toLocaleDateString()}}

{{docApp.title}}

{{docApp.description}}

Connect an AI assistant

Your AI assistant can read this documentation directly, so it answers from the current content instead of guessing. Add one of the servers below to your client — they use the Model Context Protocol (MCP). Each one covers a different body of content, so add the one you need.

The catalog did not load. Refresh the page to try again.

Loading…

How can we help?

{{docApp.searchError}}

Keep typing  - a search needs at least two characters

Searching in {{docApp.searchFilterBySpecificBookTitle}}

 {{docApp.currentResultsSearchText}}  in {{docApp.searchFilterBySpecificBookTitle}}
Found {{docApp.searchResponse.totalResultsAvailable}} matches. Showing the top {{docApp.searchResponse.results ? docApp.searchResponse.results.length : 0}}. Use a more specific search to further narrow down the results.
No documentation pages match this search, so all content types are shown. Most matches are in {{docApp.searchDocTypeRescue.best.name}}.
There is no book with the ID "{{docApp.searchBookRescue.bid}}", so the book filter from this link was ignored and results from all books are shown.

You have an odd number of " characters in your search terms - each one needs closing with a matching " character!

  • {{resultItem.title}} {{resultItem.matchedBy === 'semantic' ? 'semantic' : (resultItem.matchedBy === 'both' ? 'keyword + semantic' : 'keyword')}}

    {{resultItem.url}}

{{docApp.libraryHomeViewProduct.title || docApp.libraryHomeViewProduct.id}}

{{docApp.libraryHomeViewProduct.description}}

  1. {{book.title}}

Collections / Complete Collection

  • Article
  • 3 minutes to read

Operation Information

Completes a Collection request on the LapSafe / Onarken platform, recording the outcome and any bay rejections that occurred.

This is a Free Tier Integration.

Authentication

This operation requires authentication, the details of which can be securely stored on your instance in a KeySafe Key of type LapSafe Authentication.

To create a key of this type:

  • In the Configuration area of your Hornbill instance, navigate to Platform Configuration > Security > KeySafe;
  • Click on the + Create New Key button;
  • On the resulting Create New Key form, choose LapSafe Authentication in the Type pick list;
  • Give the LapSafe Authentication KeySafe key a Title (this is the name / identifier for the LapSafe Authentication account as you will see it when using the cloud automation node in your workflows);
  • Optionally populate the Description field;
  • Populate the following fields accordingly, then click the Create Key button to create your new key:
Name Type Description
domain string Your LapSafe Instance
API Token string The API Token which can be generated within Profile > API tokens

Tip

To connect to LapSafe, you will need to input your username and password for your LapSafe account.

Revoking Access

If at any point you wish to revoke access to any of the above accounts from your Hornbill instance, just delete the relevant KeySafe key(s) from the KeySafe list.

Warning

This will revoke the rights of any existing Cloud Automation Node in your Hornbill Workflows that are using the revoked LapSafe Authentication account, so you will need to manage these workflows accordingly.

Input Parameters

Display Name ID Type Description Required Supported Values
Collection ID id string The UUID of the collection request to complete. Yes None provided
Collected At collected_at string The date and time the asset was collected in the format of YYYY-MM-DDTHH:MM:SS.SSSZ (e.g. 2026-01-01T12:00.000Z). No None provided
Transaction ID transaction_id string An optional external transaction reference for this completion. Yes None provided

Output Parameters

Display Name ID Type Description
Status status string The outcome of the operation — ok or failed.
Error error string Error detail returned if the operation did not succeed.
ID id string The UUID of the drop-off record associated with the completed collection.
Creator ID creator_id string The UUID of the user who created the drop-off request.
User ID user_id string The UUID of the user who made the drop-off.
Installation ID installation_id string The UUID of the installation the drop-off was assigned to.
Bay ID bay_id string The UUID of the bay used for the drop-off.
Asset ID asset_id string The UUID of the asset that was dropped off.
Transition Asset To Status transition_asset_to_status string The status the asset was transitioned to (e.g. EndOfLife).
Asset Description asset_description string A description of the asset.
Notes notes string Any additional notes attached to the drop-off request.
Dropped Off At dropped_off_at string The date and time the asset was dropped off (ISO 8601).
Collected At collected_at string The date and time the asset was collected (ISO 8601).
Expires At expires_at string The date and time the drop-off request expires (ISO 8601).
Bay Requirements — Minimum Size bayRequirementsMinimumSize string The minimum bay size required (e.g. ExtraSmall).
Bay Requirements — Charging Type bayRequirementsChargingType string The charging type required (e.g. ChargeLine).
Bay Requirements — Connectivity Equipment bayRequirementsConnectivityEquipment string The connectivity equipment required (e.g. DataTransfer).
With Collection For with_collection_for string JSON string containing the array of user UUIDs authorised to collect this drop-off.
  • Version {{docApp.book.version}}
  • Node {{docApp.node}} / {{docApp.build}}
In This Document