Utility.Registry.V0.Holding.Unlock

Templates

template AcceptedUnlock

An accepted unlock.

Signatory: (DA.Internal.Record.getField @"holder" unlock), (DA.Internal.Record.getField @"locker" unlock)

Field	Type	Description
unlock	Unlock	Accepted unlock payload.
holdingLabel	Text	Label of the holding to unlock.

• Choice AcceptedUnlock_Execute

  Execute an accepted unlock.

  Controller: (DA.Internal.Record.getField @"registrar" unlock)

  Returns: AcceptedUnlock_Execute_Result

  Field	Type	Description
  instrumentConfigurationCid	ContractId InstrumentConfiguration	Instrument configuration.
  credentialCids	[ContractId Credential]	Credentials of the holder.
  holdingCids	[ContractId Holding]	Holdings to unlock.

• Choice AcceptedUnlock_Fail

  Fail an accepted unlock.

  Controller: (DA.Internal.Record.getField @"registrar" unlock)

  Returns: AcceptedUnlock_Fail_Result

  Field	Type	Description
  reason	Text	Reason for failure.

• Choice Archive

  Controller: (DA.Internal.Record.getField @"holder" unlock), (DA.Internal.Record.getField @"locker" unlock)

  Returns: ()

  (no fields)

template ExecutedUnlock

An executed unlock.

Signatory: (DA.Internal.Record.getField @"registrar" unlock)

Field	Type	Description
unlock	Unlock	Lock payload.
holdingLabel	Text	Label of the holding to unlock.

• Choice Archive

  Controller: (DA.Internal.Record.getField @"registrar" unlock)

  Returns: ()

  (no fields)

• Choice ExecutedUnlock_Delete

  Deletes an executed unlock.

  Controller: (DA.Internal.Record.getField @"registrar" unlock)

  Returns: ExecutedUnlock_Delete_Result

  (no fields)

template FailedUnlock

A failed unlock.

Signatory: (DA.Internal.Record.getField @"registrar" unlock)

Field	Type	Description
unlock	Unlock	Rejected unlock payload.
reason	Text	Reason for failure.

• Choice Archive

  Controller: (DA.Internal.Record.getField @"registrar" unlock)

  Returns: ()

  (no fields)

• Choice FailedUnlock_Delete

  Deletes a rejected unlock.

  Controller: (DA.Internal.Record.getField @"registrar" unlock)

  Returns: FailedUnlock_Delete_Result

  (no fields)

template RejectedUnlock

A rejected unlock.

Signatory: (DA.Internal.Record.getField @"holder" unlock), (DA.Internal.Record.getField @"locker" unlock)

Field	Type	Description
unlock	Unlock	Rejected unlock payload.
reason	Text	Reason for rejection.

• Choice Archive

  Controller: (DA.Internal.Record.getField @"holder" unlock), (DA.Internal.Record.getField @"locker" unlock)

  Returns: ()

  (no fields)

• Choice RejectedUnlock_Delete

  Deletes a rejected unlock.

  Controller: (DA.Internal.Record.getField @"registrar" unlock)

  Returns: RejectedUnlock_Delete_Result

  (no fields)

template UnlockOffer

An offer to unlock a holding

Signatory: (DA.Internal.Record.getField @"provider" unlock), (DA.Internal.Record.getField @"holder" unlock)

Field	Type	Description
unlock	Unlock	Unlock payload.
holdingLabel	Text	Label of the holding to lock.

• Choice Archive

  Controller: (DA.Internal.Record.getField @"provider" unlock), (DA.Internal.Record.getField @"holder" unlock)

  Returns: ()

  (no fields)

• Choice UnlockOffer_Accept

  Accepts a unlock offer.

  Controller: (DA.Internal.Record.getField @"locker" unlock)

  Returns: UnlockOffer_Accept_Result

  (no fields)

• Choice UnlockOffer_Cancel

  Cancels a unlock offer.

  Controller: (DA.Internal.Record.getField @"holder" unlock)

  Returns: UnlockOffer_Cancel_Result

  (no fields)

• Choice UnlockOffer_Reject

  Rejects a unlock offer.

  Controller: (DA.Internal.Record.getField @"locker" unlock)

  Returns: UnlockOffer_Reject_Result

  Field	Type	Description
  reason	Text	Reason for rejection.

template UnlockRequest

A request to unlock a holding

Signatory: (DA.Internal.Record.getField @"provider" unlock), (DA.Internal.Record.getField @"locker" unlock)

Field	Type	Description
unlock	Unlock	Lock offer payload.

• Choice Archive

  Controller: (DA.Internal.Record.getField @"provider" unlock), (DA.Internal.Record.getField @"locker" unlock)

  Returns: ()

  (no fields)

• Choice UnlockRequest_Accept

  Accepts an unlock request.

  Controller: (DA.Internal.Record.getField @"holder" unlock)

  Returns: UnlockRequest_Accept_Result

  Field	Type	Description
  holdingLabel	Text	Label of the holding to lock.

• Choice UnlockRequest_Cancel

  Cancels an unlock request.

  Controller: (DA.Internal.Record.getField @"locker" unlock)

  Returns: UnlockRequest_Cancel_Result

  (no fields)

• Choice UnlockRequest_Reject

  Rejects an unlock request.

  Controller: (DA.Internal.Record.getField @"holder" unlock)

  Returns: UnlockRequest_Reject_Result

  Field	Type	Description
  reason	Text	Reason for rejection.

Data Types

data AcceptedUnlock_Execute_Result

Result of AcceptedUnlock_Execute.

AcceptedUnlock_Execute_Result

Field	Type	Description
holdingCid	ContractId Holding	Result of unlock.
remainingCids	[ContractId Holding]	Remaining locked holdings.
executedUnlockCid	ContractId ExecutedUnlock	Executed unlock.

data AcceptedUnlock_Fail_Result

Result of AcceptedUnlock_Fail.

AcceptedUnlock_Fail_Result

Field	Type	Description
failedUnlockCid	ContractId FailedUnlock	Failed unlock.

data ExecutedUnlock_Delete_Result

Result of ExecutedUnlock_Delete.

ExecutedUnlock_Delete_Result

(no fields)

data FailedUnlock_Delete_Result

Result of FailedUnlock_Delete.

FailedUnlock_Delete_Result

(no fields)

data RejectedUnlock_Delete_Result

Result of RejectedUnlock_Delete.

RejectedUnlock_Delete_Result

(no fields)

data Unlock

Unlock payload.

Unlock

Field	Type	Description
operator	Party	Utility operator.
provider	Party	Provider of the initiator of the unlock.
registrar	Party	Registrar of holding.
holder	Party	Holder.
locker	Party	Locker.
lockContext	Text	Context for the lock.
instrumentIdentifier	InstrumentIdentifier	Instrument id to unlock.
amount	Decimal	Amount to unlock.
reference	Text	Reference for the unlock.
batch	Batch	Batch the unlock belongs to.

data UnlockOffer_Accept_Result

Result of UnlockOffer_Accept.

UnlockOffer_Accept_Result

Field	Type	Description
acceptedUnlockCid	ContractId AcceptedUnlock	Accepted unlock.

data UnlockOffer_Cancel_Result

Result of UnlockOffer_Cancel.

UnlockOffer_Cancel_Result

(no fields)

data UnlockOffer_Reject_Result

Result of UnlockOffer_Reject.

UnlockOffer_Reject_Result

Field	Type	Description
rejectedUnlockCid	ContractId RejectedUnlock	Rejected unlock.

data UnlockRequest_Accept_Result

Result of UnlockRequest_Accept.

UnlockRequest_Accept_Result

Field	Type	Description
acceptedUnlockCid	ContractId AcceptedUnlock	Accepted unlock.

data UnlockRequest_Cancel_Result

Result of UnlockRequest_Cancel.

UnlockRequest_Cancel_Result

(no fields)

data UnlockRequest_Reject_Result

Result of UnlockRequest_Reject.

UnlockRequest_Reject_Result

Field	Type	Description
rejectedUnlockCid	ContractId RejectedUnlock	Rejected unlock.