Skip to main content
Version: 2.0

TransactionResult

A context type representing the result of a transaction initiated via FDC3, which SHOULD be returned as an IntentResult by intents that create, retrieve, update or delete content or records in another application. Its purpose is to provide a status and message (where needed) for the transaction and MAY wrap a returned context object.

Schema

https://github.com/finos/FDC3/tree/main/schemas/context/transactionresult.schema.json

Type

fdc3.transactionResult

Properties

status

The status of the transaction being reported.

Type: string

Possible values: Created, Deleted, Updated, Failed

Example Value: Updated

context

A context object returned by the transaction, possibly with updated data.

Reference: context

Example Value:

{
"type": "fdc3.contact",
"name": "Jane Doe",
"id": {
"email": "jane.doe@mail.com"
}
}

Example

{
"type": "fdc3.transactionResult",
"status": "Updated",
"context": {
"type": "fdc3.contact",
"name": "Jane Doe",
"id": {
"email": "jane.doe@mail.com"
}
},
"message": "record with id 'jane.doe@mail.com' was updated"
}